| 1 | # Contributing to jscodeshift
|
| 2 | We want to make contributing to this project as easy and transparent as
|
| 3 | possible.
|
| 4 |
|
| 5 | ## Code of Conduct
|
| 6 | The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
|
| 7 |
|
| 8 | ## Our Development Process
|
| 9 | The majority of development on jscodeshift will occur through GitHub. Accordingly,
|
| 10 | the process for contributing will follow standard GitHub protocol.
|
| 11 |
|
| 12 | ## Pull Requests
|
| 13 | We actively welcome your pull requests.
|
| 14 |
|
| 15 | 1. Fork the repo and create your branch from `master`.
|
| 16 | 2. If you've added code that should be tested, add tests.
|
| 17 | 3. If you've changed APIs, update the documentation.
|
| 18 | 4. Ensure the test suite passes.
|
| 19 | 5. Make sure your code lints.
|
| 20 | 6. If you haven't already, complete the Contributor License Agreement ("CLA").
|
| 21 |
|
| 22 | ## Contributor License Agreement ("CLA")
|
| 23 | In order to accept your pull request, we need you to submit a CLA. You only need
|
| 24 | to do this once to work on any of Facebook's open source projects.
|
| 25 |
|
| 26 | Complete your CLA here: <https://code.facebook.com/cla>
|
| 27 |
|
| 28 | ## Issues
|
| 29 | We use GitHub issues to track public bugs. Please ensure your description is
|
| 30 | clear and has sufficient instructions to be able to reproduce the issue.
|
| 31 |
|
| 32 | Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
|
| 33 | disclosure of security bugs. In those cases, please go through the process
|
| 34 | outlined on that page and do not file a public issue.
|
| 35 |
|
| 36 | ## Coding Style
|
| 37 | * Use semicolons;
|
| 38 | * Commas last,
|
| 39 | * 2 spaces for indentation (no tabs)
|
| 40 | * Prefer `'` over `"`
|
| 41 | * `'use strict';`
|
| 42 | * 80 character line length
|
| 43 | * "Attractive"
|
| 44 |
|
| 45 | ### License
|
| 46 |
|
| 47 | jscodeshift is [MIT licensed](./LICENSE).
|