summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2020-08-11 16:49:57 +0200
committerDaniel Stenberg <daniel@haxx.se>2020-08-11 17:11:03 +0200
commita80fc09052c2368485b59eab27f6c956f8a9de73 (patch)
tree6e2eff66e9e934745927467649dc855051abd65e
parentd4ea401966a90044b4d00e3d94eee84adb9fab43 (diff)
downloadcurl-bagder/contribute-commit.tar.gz
CONTRIBUTE: extend git commit message descriptionbagder/contribute-commit
In particular how the first line works.
-rw-r--r--docs/CONTRIBUTE.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md
index 978b87d27..579ba32bb 100644
--- a/docs/CONTRIBUTE.md
+++ b/docs/CONTRIBUTE.md
@@ -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