diff options
| author |  Lubomir I. Ivanov <neolit123@gmail.com> | 2018-03-02 15:06:19 +0200 |
|---|---|---|
| committer |  Dirk Hohndel <dirk@hohndel.org> | 2018-03-02 08:24:05 -0800 |
| commit | afc9dd5f3836e7c9c75eab2435b7bd5e20a71bf9 (patch) | |
| tree | a67f061680103c217d78ecdb6959e7f3e0259ad9 /CONTRIBUTING.md | |
| parent | 0fa6422a042c207cd52f09f8e88809adee4d4a24 (diff) | |
| download | subsurface-afc9dd5f3836e7c9c75eab2435b7bd5e20a71bf9.tar.gz | |
CONTIRBUTING.md: add a note about imperative mood
Add a note in CONTIRBUTING.md that imperative mood
is the preferred way to write commit messages.
Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f53c8f88..1e13cb912 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,6 +47,9 @@ Signed-off-by: Your Name That header line really should be meaningful, and really should be just one line. The header line is what is shown by tools like gitk and shortlog, and should summarize the change in one readable line of text, independently of the longer explanation. +The prefered way to write a commit message is using imperative mood, e.g. "Make foo do xyz" instead of "This patch makes foo do xyz" or "I made foo do xyz", as if you are giving commands or requests to the code base. +https://en.wikipedia.org/wiki/Imperative_mood + ![gitk sample][10] Example with gitk |