xref: /aosp_15_r20/external/volley/CONTRIBUTING.md (revision a494ed5db247d14ea5602de4a744bb4a531fd3a7)
1*a494ed5dSAndroid Build Coastguard Worker# How to contribute
2*a494ed5dSAndroid Build Coastguard Worker
3*a494ed5dSAndroid Build Coastguard WorkerWe'd love to accept your patches and contributions to this project. There are
4*a494ed5dSAndroid Build Coastguard Workerjust a few small guidelines you need to follow.
5*a494ed5dSAndroid Build Coastguard Worker
6*a494ed5dSAndroid Build Coastguard Worker## Contributor License Agreement
7*a494ed5dSAndroid Build Coastguard Worker
8*a494ed5dSAndroid Build Coastguard WorkerContributions to any Google project must be accompanied by a Contributor License
9*a494ed5dSAndroid Build Coastguard WorkerAgreement. This is necessary because you own the copyright to your changes, even
10*a494ed5dSAndroid Build Coastguard Workerafter your contribution becomes part of this project. So this agreement simply
11*a494ed5dSAndroid Build Coastguard Workergives us permission to use and redistribute your contributions as part of the
12*a494ed5dSAndroid Build Coastguard Workerproject. Head over to <https://cla.developers.google.com/> to see your current
13*a494ed5dSAndroid Build Coastguard Workeragreements on file or to sign a new one.
14*a494ed5dSAndroid Build Coastguard Worker
15*a494ed5dSAndroid Build Coastguard WorkerYou generally only need to submit a CLA once, so if you've already submitted one
16*a494ed5dSAndroid Build Coastguard Worker(even if it was for a different project), you probably don't need to do it
17*a494ed5dSAndroid Build Coastguard Workeragain.
18*a494ed5dSAndroid Build Coastguard Worker
19*a494ed5dSAndroid Build Coastguard Worker## Code reviews
20*a494ed5dSAndroid Build Coastguard Worker
21*a494ed5dSAndroid Build Coastguard WorkerAll submissions, including submissions by project members, require review. We
22*a494ed5dSAndroid Build Coastguard Workeruse GitHub pull requests for this purpose. Consult [GitHub Help] for more
23*a494ed5dSAndroid Build Coastguard Workerinformation on using pull requests.
24*a494ed5dSAndroid Build Coastguard Worker
25*a494ed5dSAndroid Build Coastguard Worker[GitHub Help]: https://help.github.com/articles/about-pull-requests/
26*a494ed5dSAndroid Build Coastguard Worker
27*a494ed5dSAndroid Build Coastguard Worker## Preparing a pull request for review
28*a494ed5dSAndroid Build Coastguard Worker
29*a494ed5dSAndroid Build Coastguard WorkerEnsure your change is properly formatted by running:
30*a494ed5dSAndroid Build Coastguard Worker
31*a494ed5dSAndroid Build Coastguard Worker```console
32*a494ed5dSAndroid Build Coastguard Worker$ ./gradlew googleJavaFormat
33*a494ed5dSAndroid Build Coastguard Worker```
34*a494ed5dSAndroid Build Coastguard Worker
35*a494ed5dSAndroid Build Coastguard WorkerThen verify that your change builds and passes tests with:
36*a494ed5dSAndroid Build Coastguard Worker
37*a494ed5dSAndroid Build Coastguard Worker```console
38*a494ed5dSAndroid Build Coastguard Worker$ ./gradlew --continue verifyGoogleJavaFormat build connectedCheck
39*a494ed5dSAndroid Build Coastguard Worker```
40*a494ed5dSAndroid Build Coastguard Worker
41*a494ed5dSAndroid Build Coastguard WorkerPlease correct any failures before requesting a review.
42