We aim to make contributing to this project as easy and transparent as possible.
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.
We welcome 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 or added APIs, update the documentation.
- Make sure the test suite passes.
- If you haven't already, complete the Contributor License Agreement ("CLA").
Each pull request is first submitted into Facebook's internal repositories by a Facebook team member. Once the commit has successfully passed Facebook's internal test suite, it will be exported back out from Facebook's repository. We endeavour to do this as soon as possible for all commits.
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.
By contributing to Spectrum, you agree that your contributions will be licensed under its MIT license.
Match the style and conventions of the surrounding code. We have automated tools that will enforce style for some files (e.g. the C++ core) once we import your pull request into our internal code reviewing tools.