We want to make contributing to this project as easy and transparent as possible.
We actively welcome your pull requests.
- Fork the repo and create your branch from
main. - 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").
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
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.
Format with clang-format. A slightly custom style configuration is located in
the top-level directory with name .clang-format
Make sure to cover your code changes with new unit-tests or update existing ones. Also, ensure your changes are backward compatible. We will soon provide an emulation tool to test OpenR changes in a virtual network.
By contributing to OpenR, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.