diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..013cbb3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing + +[![GitHub issues](https://img.shields.io/github/issues-raw/devfolioco/react-otp-input?logo=github)](https://github.com/devfolioco/react-otp-input/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/devfolioco/react-otp-input?logo=git)](https://github.com/devfolioco/react-otp-input/pulls) + +Feel free to open [issues](https://github.com/devfolioco/react-otp-input/issues/new/choose) and [pull requests](https://github.com/devfolioco/react-otp-input/pulls)! + +## Reporting Issues and Asking Questions + +Before opening an issue, please search the [issue tracker](https://github.com/devfolioco/react-otp-input/issues) to make sure your issue hasn't already been reported. + +## Development + +Visit the [Issue tracker](https://github.com/devfolioco/react-otp-input/issues) to find a list of open issues that need attention. + +Fork, then clone the repo: + +``` +git clone https://github.com/your-username/react-otp-input.git + +``` +#### To run the vite example: + +``` +cd example +npm run dev +``` + +## New Features + +Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept. + +## Submitting Changes + +- Open a new issue in the [Issue tracker](https://github.com/devfolioco/react-otp-input/issues). +- Fork the repo. +- Create a new feature branch based off the `master` branch. +- Make sure all tests pass and there are no linting errors. +- Submit a pull request, referencing any issues it addresses. + +Please try to keep your pull request focused in scope and avoid including unrelated commits. + +After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements. + +Thank you for contributing! \ No newline at end of file