From 2a51b7c1c2165ddb188c511e192b75f0aa0fbead Mon Sep 17 00:00:00 2001 From: Tian Fang Date: Mon, 9 Mar 2015 22:53:57 -0700 Subject: Initial open source release of OpenBMC --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..eb35050 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +CONTRIBUTING.md + +# Contributing to OpenBMC +We want to make contributing to this project as easy and transparent as +possible. + +## Our Development Process +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. + +## Pull Requests +We actively welcome your pull requests. +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. 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: + +## 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](https://www.facebook.com/whitehat/) 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 +* 2 spaces for indentation rather than tabs +* 80 character line length -- cgit v1.1