Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (46 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

77 lines (46 loc) · 2.35 KB
Raw

Contributing to React Hook Form

As the creators and maintainers of this project, we want to ensure that react-hook-form lives and continues to grow and evolve. We would like to encourage everyone to help and support this library by contributing.

Code contributions

Here is a quick guide to doing code contributions to the library.

  1. Fork and clone the repo to your local machine git clone https://github.com/YOUR_GITHUB_USERNAME/react-hook-form.git

  2. 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

  3. Install packages by running:

    pnpm install

Pay attention that we use pnpm v11 along with Node.js 22.

  1. If you've added code that should be tested, ensure the test suite still passes.

    pnpm test && pnpm test:type

  2. Try to write some unit tests to cover as much of your code as possible.

  3. Ensure your code lints without errors.

    pnpm lint

  4. Ensure the automation suite passes by running the following two commands in parallel:

    pnpm start
# In another terminal, while 'start' runs:
pnpm e2e

  5. Ensure the build passes.

    pnpm build

  6. Ensure exports are documented. (requires build)

    pnpm api-extractor

  7. Push your branch: git push -u origin your-meaningful-branch-name

  8. Submit a pull request to the upstream react-hook-form repository.

  9. Choose a descriptive title and describe your changes briefly.

Coding style

Please follow the coding style of the project. React Hook Form uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback. The linting can be run manually with the following command: pnpm lint:fix and pnpm prettier:fix

Documentation

In case you want to change the README.md, please instead modify the docs/Template.md file, as the README is generated from it upon committing.

License

By contributing your code to the react-hook-form GitHub repository, you agree to license your contribution under the MIT license.

Contributors

Thank you to all the people who have already contributed to React Hook Form!