diff options
| -rw-r--r-- | doc/HACKING | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/HACKING b/doc/HACKING index e30b2f8..d379099 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -2,6 +2,11 @@ #+TITLE: Various hacking notes #+STARTUP: showall +* How to contribute + + The following stuff explains some basic procedures you need to + follow if you want to contribute code or documentation. + * No more ChangeLog files Do not modify any of the ChangeLog files in Libgpg-error. Starting @@ -23,3 +28,48 @@ in a "real" ChangeLog file, but keep the maximum line length at 72 or smaller, so that the generated ChangeLog lines, each with its leading TAB, will not exceed 80 columns. + +* Commit log keywords + + - GnuPG-bug-id :: Values are comma or space delimited bug numbers + from bug.gnupg.org pertaining to this commit. + - Debian-bug-id :: Same as above but from the Debian bug tracker. + - CVE-id :: CVE id number pertaining to this commit. + - Regression-due-to :: Commit id of the regression fixed by this commit. + - Fixes-commit :: Commit id this commit fixes. + - Reported-by :: Value is a name or mail address of a bug reporte. + - Suggested-by :: Value is a name or mail address of someone how + suggested this change. + - Co-authored-by :: Name or mail address of a co-author + - Some-comments-by :: Name or mail address of the author of + additional comments (commit log or code). + - Proofread-by :: Sometimes used by translation commits. + - Signed-off-by :: Name or mail address of the developer + +* Sending patches + + - submitting patches, and subsequent discussions around them, + happens via the gnupg-devel@gnupg.org public mailing list + + - send your patches to that list, preferably PGP/MIME signed. Make + sure to include a mention of 'libgpg-error' in the subject line, + the list is used for several different projects + + - if you're working from the git repo, here's a suggested workflow: + + - hack hack hack + + - commit your changes; group changes into easily-reviewable commit + units, feel free to submit several patches at once + + - e.g. if you want to submit a single patch on top of master, do: + git send-email --to=gnupg-devel@gnupg.org --annotate -1 + (please put a mention of libgpg-error into the subjects, + annotate lets you do that) + + - e.g. if you have two commits on top of master, do: + git send-email --to=gnupg-devel@gnupg.org --annotate --cover-letter -2 + (that prompts you for a summary mail to precede your actual + patch mails) + + - use --dry-run to test your setup |