CONTRIBUTING.md
We want to make contributing to this project as easy and transparent as possible.
We develop on a private branch internally at Facebook. We regularly update this github project with the changes from the internal repo. External pull requests are cherry-picked into our repo and then pushed back out.
We actively welcome your pull requests.
- Fork the repo and create your branch from
helium. - 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.
- 2 spaces for indentation rather than tabs
- 80 character line length
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
OpenBMC is made up of different packages. Each package contains recipe files that detail where to fetch source code from third party sources or local directories. The recipe files themselves are provided under the GPLv2 license, but your use of the code fetched by each recipe file is subject to the licenses of each respective third party project or as defined in the local directory.