Browse Source

Add notes about git commit messages

This improves readability of commits a lot and is easy to
follow. I think most people follow those rules already. They are based
on http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Docker-DCO-1.1-Signed-off-by: Johannes 'fish' Ziemke <github@freigeist.org> (github: discordianfish)
Johannes 'fish' Ziemke 11 years ago
parent
commit
5f00372af2
1 changed files with 4 additions and 0 deletions
  1. 4 0
      CONTRIBUTING.md

+ 4 - 0
CONTRIBUTING.md

@@ -90,6 +90,10 @@ reference to all the issues that they address.
 
 
 Pull requests must not contain commits from other users or branches.
 Pull requests must not contain commits from other users or branches.
 
 
+Commit messages must start with a capitalized and short summary (max. 50
+chars) written in the imperative, followed by an optional, more detailed
+explanatory text which is separated from the summary by an empty line.
+
 Code review comments may be added to your pull request. Discuss, then make the
 Code review comments may be added to your pull request. Discuss, then make the
 suggested modifications and push additional commits to your feature branch. Be
 suggested modifications and push additional commits to your feature branch. Be
 sure to post a comment after pushing. The new commits will show up in the pull
 sure to post a comment after pushing. The new commits will show up in the pull