diff options
authorBoris Kolpackov <boris@codesynthesis.com>2020-03-27 15:54:27 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2020-03-27 15:54:27 +0200
commit8e192a198d03368d22524c8b949eb1bf9625aa70 (patch)
parent4106166d1049de53fb93681099698ec0e777f78b (diff)
Add commit message rules to cheatsheetHEADmaster
1 files changed, 14 insertions, 0 deletions
diff --git a/cheatsheet.txt b/cheatsheet.txt
index 592d8d9..15b2f31 100644
--- a/cheatsheet.txt
+++ b/cheatsheet.txt
@@ -26,6 +26,20 @@ Global Setup
git config core.hooksPath .git/hooks
+Commit Messages
+1. Separate subject from body with a blank line
+2. Limit the subject line to 78 characters
+3. Capitalize the subject line
+4. Do not end the subject line with a period
+5. Use the imperative voice in the subject line (e.g., "Implement foo" rather
+ than "Implemented foo")
+6. No articles (a/the) in the subject line
+7. Wrap the body at 78 characters
+8. Unless this is already captured in the commit payload (e.g., in
+ code comments, documentation, etc) use the body to explain what
+ and why
Undo (move to index) last commit
git reset --soft HEAD~