diff --git a/fs_image/public_tld/CONTRIBUTING.md b/fs_image/public_tld/CONTRIBUTING.md new file mode 100644 index 00000000..801ece5c --- /dev/null +++ b/fs_image/public_tld/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to fs_image +We want to make contributing to this project as easy and transparent as +possible. + +## 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. + +## License +By contributing to fs_image, you agree that your contributions will be licensed +under the LICENSE file in the root directory of this source tree.