| 1 | # Contributing to Recoil
|
| 2 | We want to make contributing to this project as easy and transparent as
|
| 3 | possible.
|
| 4 |
|
| 5 | ## Our Development Process
|
| 6 | Some people will be working directly on GitHub. These changes will be public from the beginning. Other changesets will come via a bridge with Facebook's internal source control. This is a necessity as it allows engineers at Facebook outside of the core team to move fast and contribute from an environment they are comfortable in.
|
| 7 |
|
| 8 | ## The `master` Branch is Unsafe
|
| 9 | We will do our best to keep master in good shape, with tests passing at all times. But we will sometimes make API changes that your application might not be compatible with. We will do our best to communicate these changes and always version appropriately so you can lock into a specific version if need be.
|
| 10 |
|
| 11 | ## Pull Requests
|
| 12 | We actively welcome your pull requests.
|
| 13 |
|
| 14 | 1. Fork the repo and create your branch from `master`.
|
| 15 | 2. If you've added code that should be tested, add tests.
|
| 16 | 3. If you've changed APIs, update the documentation.
|
| 17 | 4. Ensure the test suite passes.
|
| 18 | 5. Make sure your code lints and is formatted with `prettier`.
|
| 19 | 6. If you haven't already, complete the Contributor License Agreement ("CLA").
|
| 20 |
|
| 21 | ## Getting in Touch
|
| 22 |
|
| 23 | Please file issues liberally. That's the easiest way to contact us in a way that
|
| 24 | ensures everyone working on Recoil can see it. We are eager for your questions, input, and to hear about your experience.
|
| 25 |
|
| 26 | ## Contributor License Agreement ("CLA")
|
| 27 | In order to accept your pull request, we need you to submit a CLA. You only need
|
| 28 | to do this once to work on any of Facebook's open source projects.
|
| 29 |
|
| 30 | Complete your CLA here: <https://code.facebook.com/cla>
|
| 31 |
|
| 32 | ## Issues
|
| 33 | We use GitHub issues to track public bugs. Please ensure your description is
|
| 34 | clear and has sufficient instructions to be able to reproduce the issue.
|
| 35 |
|
| 36 | Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
|
| 37 | disclosure of security bugs. In those cases, please go through the process
|
| 38 | outlined on that page and do not file a public issue.
|
| 39 |
|
| 40 | ## License
|
| 41 | By contributing to Recoil, you agree that your contributions will be licensed
|
| 42 | under the LICENSE file in the root directory of this source tree.
|