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