Add git commit message heuristics

[hubacji1/oneflow.git] / intro.md

diff --git a/intro.md b/intro.md
index 42ce2b8f8b1acd844fe13a9ea75ebebf0530c0c3..2b33ee7af92ae00dfd6dbb615f26d597c680b58c 100644 (file)
--- a/intro.md
+++ b/intro.md
@@ -133,9 +133,21 @@ git reset FILE
 ```
 
 ## Command `git commit`
-When sure that staged changes should be commited to the history, use `git
-commit -m'COMMIT MSG'`. For commit messages, some rules are good to keep in
-mind [1][]:
+When sure that staged changes should be commited to the history, use:
+```
+git commit -m'COMMIT MSG'
+```
+
+Command without parameters will open text editor to let type the commit
+message.
+```
+git commit
+```
+
+Default text editor is `vim`. It can be closed by sequence `<Esc>:q!<Enter>`.
+
+Please, keep these [The seven rules of a great Git commit message][1] when
+writing the git commit messages:
 - Separate subject from body with a blank line.
 - Limit the subject line to 50 characters.
 - Capitalize the subject line.
@@ -144,6 +156,13 @@ mind [1][]:
 - Wrap the body at 72 characters.
 - Use the body to explain what and why vs. how.
 
+If still it's lot to remember, the heuristics is that a properly formed Git
+commit subject line should always be able to complete the following sentence:
+
+**If applied, this commit will your subject line here**
+
+[1]: https://chris.beams.io/posts/git-commit/
+
 # Cheat sheet
 Use `git COMMAND --help` for showing the help!
 
@@ -174,5 +193,3 @@ Use `git COMMAND --help` for showing the help!
 - `git reset FILE`
 - `git commit -m'COMMIT MSG'`
 - `git commit`
-
-[1]: https://chris.beams.io/posts/git-commit/