diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c30e74e..e42837f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,16 @@ -# Contributing to InPlace-ABN +# Contributing to inplace_abn We want to make contributing to this project as easy and transparent as possible. ## Pull Requests -We actively welcome pull requests addressing bugs. Each pull request should be -referenced in a corresponding Issue explaining the bug and how to reproduce it. +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 @@ -12,6 +18,14 @@ 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. + ## License -By contributing to InPlace-ABN, you agree that your contributions will be licensed +By contributing to inplace_abn, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.