|
| 1 | +# Contributing to Sonar |
| 2 | + |
| 3 | +We want to make contributing to this project as easy and transparent as |
| 4 | +possible. |
| 5 | + |
| 6 | +## Our Development Process |
| 7 | + |
| 8 | +Changes from Facebook employees are synced to the GitHub repo automatically. |
| 9 | +PRs from the community are imported into our internal source control and then |
| 10 | +pushed to GitHub. |
| 11 | + |
| 12 | +For changes affecting both, native code and JavaScript, make sure to only create |
| 13 | +a single PR containing both parts of the code. |
| 14 | + |
| 15 | +Although the Sonar desktop app is only released for macOS right now, it is |
| 16 | +possible to create Windows and Linux builds of the app. Please keep this in mind |
| 17 | +when dealing with platform-specific code. |
| 18 | + |
| 19 | +## Pull Requests |
| 20 | + |
| 21 | +We actively welcome your pull requests. |
| 22 | + |
| 23 | +1. Fork the repo and create your branch from `master`. |
| 24 | +2. If you've added code that should be tested, add tests. |
| 25 | +3. If you've changed APIs, update the documentation. |
| 26 | +4. Ensure the test suite passes. |
| 27 | +5. Make sure your code lints. |
| 28 | +6. If you haven't already, complete the Contributor License Agreement ("CLA"). |
| 29 | + |
| 30 | +## Contributor License Agreement ("CLA") |
| 31 | + |
| 32 | +In order to accept your pull request, we need you to submit a CLA. You only need |
| 33 | +to do this once to work on any of Facebook's open source projects. |
| 34 | + |
| 35 | +Complete your CLA here: <https://code.facebook.com/cla> |
| 36 | + |
| 37 | +## Issues |
| 38 | + |
| 39 | +We use GitHub issues to track public bugs. Please ensure your description is |
| 40 | +clear and has sufficient instructions to be able to reproduce the issue. |
| 41 | + |
| 42 | +Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe |
| 43 | +disclosure of security bugs. In those cases, please go through the process |
| 44 | +outlined on that page and do not file a public issue. |
| 45 | + |
| 46 | +## Coding Style |
| 47 | + |
| 48 | +We are using Prettier to format our source code. The styles are enforced via |
| 49 | +eslint. Make sure everything is well formatted before creating a PR. Therefore, |
| 50 | +run `yarn lint` and `yarn fix` to apply formatting fixes. |
| 51 | + |
| 52 | +## License |
| 53 | + |
| 54 | +By contributing to Sonar, you agree that your contributions will be licensed |
| 55 | +under the LICENSE file in the root directory of this source tree. |
0 commit comments