xref: /aosp_15_r20/external/nullaway/CONTRIBUTING.md (revision f50c306653bc89b8210ce6c9e0b0b44fc134bc03)
1*f50c3066SAndroid Build Coastguard WorkerContributing to NullAway
2*f50c3066SAndroid Build Coastguard Worker=======================
3*f50c3066SAndroid Build Coastguard Worker
4*f50c3066SAndroid Build Coastguard WorkerUber welcomes contributions of all kinds and sizes. This includes everything from simple bug reports to large features.
5*f50c3066SAndroid Build Coastguard Worker
6*f50c3066SAndroid Build Coastguard WorkerWorkflow
7*f50c3066SAndroid Build Coastguard Worker--------
8*f50c3066SAndroid Build Coastguard Worker
9*f50c3066SAndroid Build Coastguard WorkerWe love GitHub issues!
10*f50c3066SAndroid Build Coastguard Worker
11*f50c3066SAndroid Build Coastguard WorkerFor small feature requests, an issue first proposing it for discussion or demo implementation in a PR suffice.
12*f50c3066SAndroid Build Coastguard Worker
13*f50c3066SAndroid Build Coastguard WorkerFor big features, please open an issue so that we can agree on the direction, and hopefully avoid investing a lot of time on a feature that might need reworking.
14*f50c3066SAndroid Build Coastguard Worker
15*f50c3066SAndroid Build Coastguard WorkerSmall pull requests for things like typos, bug fixes, etc are always welcome.
16*f50c3066SAndroid Build Coastguard Worker
17*f50c3066SAndroid Build Coastguard WorkerDOs and DON'Ts
18*f50c3066SAndroid Build Coastguard Worker--------------
19*f50c3066SAndroid Build Coastguard Worker
20*f50c3066SAndroid Build Coastguard Worker* DO format your code using Google Java Format.  An appropriate Git pre-commit hook is automatically installed the first time you run `./gradlew`.
21*f50c3066SAndroid Build Coastguard Worker* DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
22*f50c3066SAndroid Build Coastguard Worker* DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion.
23*f50c3066SAndroid Build Coastguard Worker
24*f50c3066SAndroid Build Coastguard Worker* DON'T submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it.
25*f50c3066SAndroid Build Coastguard Worker
26*f50c3066SAndroid Build Coastguard WorkerGuiding Principles
27*f50c3066SAndroid Build Coastguard Worker------------------
28*f50c3066SAndroid Build Coastguard Worker
29*f50c3066SAndroid Build Coastguard Worker* We allow anyone to participate in our projects. Tasks can be carried out by anyone that demonstrates the capability to complete them
30*f50c3066SAndroid Build Coastguard Worker* Always be respectful of one another. Assume the best in others and act with empathy at all times
31*f50c3066SAndroid Build Coastguard Worker* Collaborate closely with individuals maintaining the project or experienced users. Getting ideas out in the open and seeing a proposal before it's a pull request helps reduce redundancy and ensures we're all connected to the decision making process
32