diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ac16ed7e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +Contributing +============ + +Keeping the project small and stable limits our ability to accept new contributors. We are not +seeking new committers at this time, but some small contributions are welcome. + +If you've found a security problem, please follow our [bug bounty][security] program. + +If you've found a bug, please contribute a failing test case so we can study and fix it. + +Before code can be accepted all contributors must complete our +[Individual Contributor License Agreement (CLA)][cla]. + + +Code Contributions +------------------ + +Get working code on a personal branch with tests passing before you submit a PR: + +``` +./gradlew clean check +``` + +Please make every effort to follow existing conventions and style in order to keep the code as +readable as possible. + +Contribute code changes through GitHub by forking the repository and sending a pull request. We +squash all pull requests on merge. + + +Committer's Guides +------------------ + + * [Releasing][releasing] + + [cla]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1 + [releasing]: http://square.github.io/okio/releasing/ + [security]: http://square.github.io/okio/security/ |