fbbf8cf16b
fbshipit-source-id: b6fc29740c6875d2e78953b8a7123890a67930f2 Co-authored-by: Sebastian McKenzie <sebmck@fb.com> Co-authored-by: John Knox <jknox@fb.com> Co-authored-by: Emil Sjölander <emilsj@fb.com> Co-authored-by: Pritesh Nandgaonkar <prit91@fb.com>
2.0 KiB
Contributing to Sonar
We want to make contributing to this project as easy and transparent as possible.
Our Development Process
Changes from Facebook employees are synced to the GitHub repo automatically. PRs from the community are imported into our internal source control and then pushed to GitHub.
For changes affecting both, native code and JavaScript, make sure to only create a single PR containing both parts of the code.
Although the Sonar desktop app is only released for macOS right now, it is possible to create Windows and Linux builds of the app. Please keep this in mind when dealing with platform-specific code.
Pull Requests
We actively welcome your pull requests.
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- If you haven't already, complete the Contributor License Agreement ("CLA").
Contributor License Agreement ("CLA")
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.
Complete your CLA here: https://code.facebook.com/cla
Issues
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
Coding Style
We are using Prettier to format our source code. The styles are enforced via
eslint. Make sure everything is well formatted before creating a PR. Therefore,
run yarn lint and yarn fix to apply formatting fixes.
License
By contributing to Sonar, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.