Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 1.52 KB
Raw

Contributing to React Hook Form Antd

As the creators and maintainers of this project, we want to ensure that react-hook-form-antd 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-antd.git
  1. Create a new branch from main with a meaningful name for a new feature or an issue you want to work on.
git checkout -b your-meaningful-branch-name
  1. Install packages by running.
pnpm install
  1. Test your code.
pnpm run test
  1. Ensure your code lints without errors.
pnpm run lint
  1. Ensure build passes.
pnpm run build
  1. Push your branch.
git push -u origin your-meaningful-branch-name

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

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

Coding style

Please follow the coding style of the project. React Hook Form Antd 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 run format and pnpm run lint

License

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