Adding contributing md file

Summary: We added the CONTRIBUTING.md file to our codebase for external contributors from open source community. Reviewed By: yangbk560 Differential Revision: D27470141 fbshipit-source-id: acb8cbf42517c5c36094e656e35f13916fa9aefe
coreyabs-db · Mar 31, 2021 · bf4a4f0 · bf4a4f0
1 parent bcd9832
commit bf4a4f0
Showing 1 changed file with 43 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+# Contributing to Kats
+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: <https://code.facebook.com/cla>
+
+## 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 [TODO]
+We use isort and black to format our code, you can use the following commands to format your code prior to submission:
+
+```
+(kats_venv) $ pip install isort black
+(kats_venv) $ black kats
+(kats_venv) $ isort kats --recursive --multi-line 3 --trailing-comma --force-grid-wrap 0 --line-width 88 --lines-after-imports 2 --combine-as --section-default THIRDPARTY
+```
+
+## Updates to Docs
+The documentation build process work with Python 3.7 and above.
+
+## License
+By contributing to Kats, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.