Community
Contributing
Report bugs, propose changes and run the project locally.
Bug reports, fixes and ideas are welcome. Open an issue or a pull request against the 3.x branch.
Set up
git clone https://github.com/ManukMinasyan/vue-functional-calendar.git
cd vue-functional-calendar
git checkout 3.x
npm ci
Scripts
| Command | What it does |
|---|---|
npm run dev | Starts the internal test page from src/Demo.vue. |
npm test | Runs the Vitest suite. |
npm run lint | Runs ESLint over src, tests and index.js. |
npx prettier --check src tests index.js | Checks formatting. |
npm run build | Builds dist/ for ESM, CJS and UMD, plus style.css. |
npm run docs:dev | Runs this documentation site. |
npm run docs:build | Builds this documentation site. |
The documentation site imports the calendar from the repository source, so every demo runs the current code.
Pull requests
- Branch from
3.x. - Add tests for new behavior.
- Update the documentation if you change a prop, event or slot.
- Make sure the tests and the linter pass.
Style
Two spaces, no semicolons and single quotes. Prettier enforces it with the .prettierrc in the repository.
Reporting bugs
A good report has a short summary, steps to reproduce, what you expected, what happened, and a minimal example if you can. You can use the playground to find the props that trigger the bug.
License
By contributing, you agree that your contributions are licensed under the MIT License.