xref: /aosp_15_r20/external/auto/CONTRIBUTING.md (revision 1c2bbba85eccddce6de79cbbf1645fda32e723f0)
1*1c2bbba8SAndroid Build Coastguard WorkerContributing
2*1c2bbba8SAndroid Build Coastguard Worker============
3*1c2bbba8SAndroid Build Coastguard Worker
4*1c2bbba8SAndroid Build Coastguard WorkerIf you would like to contribute code to Auto you can do so through GitHub
5*1c2bbba8SAndroid Build Coastguard Workerby forking the repository and sending a pull request.
6*1c2bbba8SAndroid Build Coastguard Worker
7*1c2bbba8SAndroid Build Coastguard WorkerWhen submitting code, please make every effort to follow existing conventions
8*1c2bbba8SAndroid Build Coastguard Workerand style in order to keep the code as readable as possible.
9*1c2bbba8SAndroid Build Coastguard Worker
10*1c2bbba8SAndroid Build Coastguard WorkerWhere appropriate, please provide unit tests or integration tests. Unit tests
11*1c2bbba8SAndroid Build Coastguard Workershould be JUnit based tests and can use either standard JUnit assertions or
12*1c2bbba8SAndroid Build Coastguard WorkerTruth assertions and be added to `<project>/src/test/java`.  Changes to
13*1c2bbba8SAndroid Build Coastguard Workercode generation or other build-time behaviour should go into small maven
14*1c2bbba8SAndroid Build Coastguard Workerprojects using the `maven-invoker-plugin`.  Examples of this are in
15*1c2bbba8SAndroid Build Coastguard Worker`generator/src/it` and can include bean-shell verification scripts and other
16*1c2bbba8SAndroid Build Coastguard Workerfacilities provided by `maven-invoker-plugin`.
17*1c2bbba8SAndroid Build Coastguard Worker
18*1c2bbba8SAndroid Build Coastguard WorkerPlease make sure your code compiles by running `mvn clean verify` which will
19*1c2bbba8SAndroid Build Coastguard Workerexecute both unit and integration test phases.  Additionally, consider using
20*1c2bbba8SAndroid Build Coastguard Workerhttp://travis-ci.org to validate your branches before you even put them into
21*1c2bbba8SAndroid Build Coastguard Workerpull requests.  All pull requests will be validated by Travis-ci in any case
22*1c2bbba8SAndroid Build Coastguard Workerand must pass before being merged.
23*1c2bbba8SAndroid Build Coastguard Worker
24*1c2bbba8SAndroid Build Coastguard WorkerIf you are adding or modifying files you may add your own copyright line, but
25*1c2bbba8SAndroid Build Coastguard Workerplease ensure that the form is consistent with the existing files, and please
26*1c2bbba8SAndroid Build Coastguard Workernote that a Google, Inc. copyright line must appear in every copyright notice.
27*1c2bbba8SAndroid Build Coastguard WorkerAll files are released with the Apache 2.0 license and any new files may only
28*1c2bbba8SAndroid Build Coastguard Workerbe accepted under the terms of that license.
29*1c2bbba8SAndroid Build Coastguard Worker
30*1c2bbba8SAndroid Build Coastguard WorkerBefore your code can be accepted into the project you must sign the
31*1c2bbba8SAndroid Build Coastguard Worker[Individual Contributor License Agreement (CLA)][1].
32*1c2bbba8SAndroid Build Coastguard Worker
33*1c2bbba8SAndroid Build Coastguard Worker
34*1c2bbba8SAndroid Build Coastguard Worker [1]: https://developers.google.com/open-source/cla/individual
35