xref: /aosp_15_r20/external/libusb/HACKING (revision 86b64dcb59b3a0b37502ecd56e119234366a6f7e)
1*86b64dcbSAndroid Build Coastguard WorkerContributing to libusb
2*86b64dcbSAndroid Build Coastguard Worker**********************
3*86b64dcbSAndroid Build Coastguard Worker
4*86b64dcbSAndroid Build Coastguard WorkerFor larger changes or API changes/extensions it may be wise to first
5*86b64dcbSAndroid Build Coastguard Workerdiscuss on the mailing list or in the issue tracker before larger
6*86b64dcbSAndroid Build Coastguard Workercoding efforts are initiated.
7*86b64dcbSAndroid Build Coastguard Worker
8*86b64dcbSAndroid Build Coastguard WorkerIf you extend or change the API make sure documentation is updated.
9*86b64dcbSAndroid Build Coastguard WorkerPlease run make -C doc and check for any Doxygen warnings.
10*86b64dcbSAndroid Build Coastguard Worker
11*86b64dcbSAndroid Build Coastguard WorkerCommit messages should be formatted to 72 chars width and have a
12*86b64dcbSAndroid Build Coastguard Workerfree-standing summary line. See for instance "Commit Guidelines" on
13*86b64dcbSAndroid Build Coastguard Workerhttps://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project
14*86b64dcbSAndroid Build Coastguard Workeror https://cbea.ms/git-commit/ about how to make well-formed commit
15*86b64dcbSAndroid Build Coastguard Workermessages.
16*86b64dcbSAndroid Build Coastguard Worker
17*86b64dcbSAndroid Build Coastguard WorkerPut detailed information in the commit message itself, which will end
18*86b64dcbSAndroid Build Coastguard Workerup in the git history. On the other hand the description that you fill
19*86b64dcbSAndroid Build Coastguard Workerin the GitHub pull request web page does not go anywhere.
20*86b64dcbSAndroid Build Coastguard Worker
21*86b64dcbSAndroid Build Coastguard WorkerFor copyright reasons it is preferable to have your full name in the
22*86b64dcbSAndroid Build Coastguard Workercommit author field. Do not update the AUTHOR file yourself, the
23*86b64dcbSAndroid Build Coastguard Workermaintainers will update it as part of the release preparation.
24*86b64dcbSAndroid Build Coastguard Worker
25*86b64dcbSAndroid Build Coastguard WorkerPlease don't touch version_nano.h in your patches or pull requests.
26