moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-12-23 16:48:49 -05:00
Code Issues Releases Wiki Activity

CONTRIBUTE: extend git commit message description

Browse Source 
In particular how the first line works.

Closes #5803
This commit is contained in:
Daniel Stenberg 2020-08-11 16:49:57 +02:00
parent d4ea401966
commit c46339eca1
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/CONTRIBUTE.md
View 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] [whatever-else-by: credit all helpers, finders, doers]
---- stop ---- ---- 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 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 make sure that you have your own user and email setup correctly in git before
you commit you commit