Thanks for your interest in React-Select. All forms of contribution are welcome, from issue reports to PRs and documentation / write-ups.
Before you open a PR:
- In development, run
yarn start
to build (and watch) the project source, and run the development server. - Please ensure all the examples work correctly after your change. If you're
adding a major new use-case, add a new example
/docs/examples
and subsequent documentation demonstrating its use/docs/pages
. - Ensure that your effort is aligned with the project's roadmap by talking to the maintainers, especially if you are going to spend a lot of time on it.
- Make sure there's an issue open for any work you take on and intend to submit as a pull request - it helps core members review your concept and direction early and is a good way to discuss what you're planning to do.
- If you open an issue and are interested in working on a fix, please let us know. We'll help you get started, rather than inadvertently doubling up on your hard work.
- Make sure you do not add regressions by running
yarn test
. - Where possible, include tests with your changes, either that demonstrates the bug, or tests the new functionality. If you're not sure how to test your changes, feel free to ping @gwyneplaine
- Please follow our established coding conventions (with regards to formatting, etc)
- All new features and changes need documentation.