Add seven rules of great git commit message

[hubacji1/oneflow.git] / README.md

diff --git a/README.md b/README.md
index 64f89c7c374b3e89fc3cd9e249a86660345c32e2..da1400b1c055928579b2e82c43a90b2c1cf78bb0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -40,4 +40,14 @@ Before commiting to the history log check twice `git diff --cached` and `git
 diff`.
 
 When sure that staged changes should be commited to the history, use `git
-commit -m'COMMIT MSG'`.
+commit -m'COMMIT MSG'`. For commit messages, some rules are good to keep in
+mind [1][]:
+- Separate subject from body with a blank line.
+- Limit the subject line to 50 characters.
+- Capitalize the subject line.
+- Do not end the subject line with a period.
+- Use the imperative mood in the subject line.
+- Wrap the body at 72 characters.
+- Use the body to explain what and why vs. how.
+
+[1]: https://chris.beams.io/posts/git-commit/