mirror of
https://github.com/Instagram/LibCST.git
synced 2025-12-23 10:35:53 +00:00
add CONTRIBUTING.md
This commit is contained in:
parent
689e705c71
commit
68576ebacd
1 changed files with 38 additions and 0 deletions
38
CONTRIBUTING.md
Normal file
38
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
# Contributing to LibCST
|
||||
We want to make contributing to this project as easy and transparent as
|
||||
possible.
|
||||
|
||||
## Our Development Process
|
||||
This github repo is the source of truth and all changes need to be reviewed by
|
||||
pull requests.
|
||||
|
||||
## 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
|
||||
We use flake8 to enforce coding style and the configuration is in [tox.ini](tox.ini)
|
||||
|
||||
## License
|
||||
By contributing to LibCST, you agree that your contributions will be licensed
|
||||
under the MIT LICENSE file in the root directory of this source tree.
|
||||
Loading…
Add table
Add a link
Reference in a new issue