| 1 | # Contributing to Regenerator
|
| 2 |
|
| 3 | Regenerator uses GitHub as its sole source of truth. Everything happens
|
| 4 | here. Facebook employees who contribute to Regenerator are expected to do
|
| 5 | so in the same way as everyone else. In other words, this document applies
|
| 6 | equally to all contributors.
|
| 7 |
|
| 8 | ### Code of Conduct
|
| 9 | The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
|
| 10 |
|
| 11 | ### `master` is unsafe
|
| 12 |
|
| 13 | We will do our best to keep `master` in good shape, with tests passing at
|
| 14 | all times. But in order to move fast, we will make API changes that your
|
| 15 | application might not be compatible with. We will do our best to
|
| 16 | communicate these changes and always version appropriately so you can lock
|
| 17 | into a specific version if need be.
|
| 18 |
|
| 19 | ### Pull Requests
|
| 20 |
|
| 21 | In case you've never submitted a pull request (PR) via GitHub before,
|
| 22 | please read [this short
|
| 23 | tutorial](https://help.github.com/articles/creating-a-pull-request). If
|
| 24 | you've submitted a PR before, there should be nothing surprising about our
|
| 25 | procedures for Regenerator.
|
| 26 |
|
| 27 | *Before* submitting a pull request, please make sure the following is done…
|
| 28 |
|
| 29 | 1. Fork the repo and create your branch from `master`.
|
| 30 | 2. If you've added code that should be tested, add tests!
|
| 31 | 3. Ensure the test suite passes (`npm test`).
|
| 32 | 4. If you haven't already, complete the CLA.
|
| 33 | 5. Submit a pull request via GitHub.
|
| 34 | 6. Check that Travis CI tests pass (pull request turns green).
|
| 35 |
|
| 36 | ### Contributor License Agreement ("CLA")
|
| 37 |
|
| 38 | In order to accept your pull request, we need you to submit a CLA. You
|
| 39 | only need to do this once, so if you've done this for another Facebook
|
| 40 | open source project, you're good to go. If you are submitting a pull
|
| 41 | request for the first time, just let us know that you have completed the
|
| 42 | CLA and we can cross-check with your GitHub username.
|
| 43 |
|
| 44 | Complete your CLA here: <https://code.facebook.com/cla>
|
| 45 |
|
| 46 | ## Bugs
|
| 47 |
|
| 48 | ### Where to Find Known Issues
|
| 49 |
|
| 50 | We will be using GitHub Issues for all bugs. Before filing a new issue,
|
| 51 | please try to make sure your problem doesn't already exist. If you think
|
| 52 | your issue is more general than one that already exists, our preference is
|
| 53 | still to modify the original issue to reflect the underlying problem more
|
| 54 | faithfully.
|
| 55 |
|
| 56 | ### Reporting New Issues
|
| 57 |
|
| 58 | The best way to get a bug fixed is to provide a reduced test case, and the
|
| 59 | easiest way to reduce a testcase is to edit it in [the
|
| 60 | sandbox](http://facebook.github.io/regenerator/) until you're satisfied
|
| 61 | and then click the "report a bug" link (the new issue will be populated
|
| 62 | automatically with your code).
|
| 63 |
|
| 64 | ### Security Bugs
|
| 65 |
|
| 66 | Facebook has a [bounty program](https://www.facebook.com/whitehat/) for
|
| 67 | the safe disclosure of security bugs. With that in mind, please do not
|
| 68 | file public issues and go through the process outlined on that page.
|
| 69 |
|
| 70 | ## Coding Style
|
| 71 |
|
| 72 | * Use semicolons;
|
| 73 | * Commas last,
|
| 74 | * 2 spaces for indentation (no tabs).
|
| 75 | * Prefer `"` over `'`
|
| 76 | * 80 character line length
|
| 77 | * Match surrounding coding style.
|
| 78 | * Less code is better code.
|
| 79 |
|
| 80 | ## License
|
| 81 |
|
| 82 | By contributing to Regenerator, you agree that your contributions will be
|
| 83 | licensed under the [MIT License](LICENSE).
|