]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
CONTRIBUTE: extend git commit message description
authorDaniel Stenberg <daniel@haxx.se>
Tue, 11 Aug 2020 14:49:57 +0000 (16:49 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 12 Aug 2020 05:52:58 +0000 (07:52 +0200)
In particular how the first line works.

Closes #5803

docs/CONTRIBUTE.md

index 978b87d27d9d1279b2bfacad1efc75f65c80f196..579ba32bb8e8fb19afa0ff84fe024474222ae6ca 100644 (file)
@@ -200,6 +200,16 @@ A short guide to how to write commit messages in the curl project.
     [whatever-else-by: credit all helpers, finders, doers]
     ---- stop ----
 
+The first line is a succinct description of the change:
+
+ - use the imperative, present tense: "change" not "changed" nor "changes"
+ - don't capitalize first letter
+ - no dot (.) at the end
+
+The `[area]` in the first line can be `http2`, `cookies`, `openssl` or
+similar. There's no fixed list to select from but using the same "area" as
+other related changes could make sense.
+
 Don't forget to use commit --author="" if you commit someone else's work, and
 make sure that you have your own user and email setup correctly in git before
 you commit