From 188a913b073cbaf6862c3e7be6b4de45772f6016 Mon Sep 17 00:00:00 2001 From: Tormod Volden Date: Sun, 5 Nov 2023 13:56:38 +0100 Subject: [PATCH] Add HACKING file with hints on proper commits Signed-off-by: Tormod Volden --- HACKING | 25 +++++++++++++++++++++++++ libusb/version_nano.h | 2 +- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 HACKING diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..2961163 --- /dev/null +++ b/HACKING @@ -0,0 +1,25 @@ +Contributing to libusb +********************** + +For larger changes or API changes/extensions it may be wise to first +discuss on the mailing list or in the issue tracker before larger +coding efforts are initiated. + +If you extend or change the API make sure documentation is updated. +Please run make -C doc and check for any Doxygen warnings. + +Commit messages should be formatted to 72 chars width and have a +free-standing summary line. See for instance "Commit Guidelines" on +https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project +or https://cbea.ms/git-commit/ about how to make well-formed commit +messages. + +Put detailed information in the commit message itself, which will end +up in the git history. On the other hand the description that you fill +in the GitHub pull request web page does not go anywhere. + +For copyright reasons it is preferable to have your full name in the +commit author field. Do not update the AUTHOR file yourself, the +maintainers will update it as part of the release preparation. + +Please don't touch version_nano.h in your patches or pull requests. diff --git a/libusb/version_nano.h b/libusb/version_nano.h index f4f74b4..a230fce 100644 --- a/libusb/version_nano.h +++ b/libusb/version_nano.h @@ -1 +1 @@ -#define LIBUSB_NANO 11807 +#define LIBUSB_NANO 11808