As the creators and maintainers of this project, we want to ensure that @rehookify/datepicker lives and continues to grow and evolve. We would like to encourage everyone to help and support this library by contributing.
Here is a quick guide to doing code contributions to the library.
-
Fork and clone the repo to your local machine
git clone https://github.com/YOUR_GITHUB_USERNAME/datepicker
-
Create a new branch from
master
with a meaningful name for a new feature or an issue you want to work on:git checkout -b your-meaningful-branch-name
-
Install pnpm and packages by running:
npm i -g pnpm
-
Install pnpm and packages by running:
pnpm i
-
Run all packages in dev mode:
pnpm dev
-
If you've added a code that should be tested, ensure the test suite still passes.
pnpm test
-
Try to write some unit tests to cover as much of your code as possible.
-
If you need to test add e2e test for you feature please create page in
./packages/examples/
and write tests in./packages/examples-e2e
-
Push your branch:
git push -u origin your-meaningful-branch-name
-
Submit a pull request to the upstream @rehookify/datepicker repository.
-
Choose a descriptive title and describe your changes briefly.
Please follow the coding style of the project. @rehookify/datepicker uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback.
Please name all new files in kebab-case: my-new-shiny-feature.ts
;
Please follow conventional commits specification for your contributions.
By contributing your code to the @rehookify/datepicker GitHub repository, you agree to license your contribution under the MIT license.