mirror of
https://github.com/square/okhttp.git
synced 2025-11-23 06:42:24 +03:00
63 lines
2.0 KiB
Markdown
63 lines
2.0 KiB
Markdown
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.
|
|
|
|
If you have a new feature idea, please build it in an external library. There are
|
|
[many libraries][works_with_okhttp] that sit on top or hook in via existing APIs. If you build
|
|
something that integrates with OkHttp, tell us so that we can link 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.
|
|
|
|
|
|
Gradle Setup
|
|
------------
|
|
|
|
```
|
|
$ cat local.properties
|
|
sdk.dir=PATH_TO_ANDROID_HOME/sdk
|
|
org.gradle.caching=true
|
|
```
|
|
|
|
Running Android Tests
|
|
---------------------
|
|
|
|
$ ANDROID_SDK_ROOT=PATH_TO_ANDROID_HOME/sdk ./gradlew :android-test:connectedCheck
|
|
|
|
Committer's Guides
|
|
------------------
|
|
|
|
* [Concurrency][concurrency]
|
|
* [Debug Logging][debug_logging]
|
|
* [Releasing][releasing]
|
|
|
|
[cla]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1
|
|
[concurrency]: https://square.github.io/okhttp/concurrency/
|
|
[debug_logging]: https://square.github.io/okhttp/debug_logging/
|
|
[releasing]: https://square.github.io/okhttp/releasing/
|
|
[security]: https://square.github.io/okhttp/security/
|
|
[works_with_okhttp]: https://square.github.io/okhttp/works_with_okhttp/
|
|
[okhttp_build]: https://github.com/square/okhttp/blob/master/okhttp/build.gradle
|