From 471665871f8a270c67e4a0276b016c8c7fa29a01 Mon Sep 17 00:00:00 2001 From: jonmoon74 Date: Fri, 23 Nov 2018 23:33:50 +0000 Subject: [PATCH] Update index.md (#25370) Added a line to the detailed commit messages section on the importance of making sure your commit messages explain what changed fro ease of roll-back --- guide/english/git/git-commit/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/guide/english/git/git-commit/index.md b/guide/english/git/git-commit/index.md index e1629276b7..6ff196ef11 100644 --- a/guide/english/git/git-commit/index.md +++ b/guide/english/git/git-commit/index.md @@ -53,6 +53,7 @@ If you commit without using the `-m` option, git will open your default text edi Bear in mind: * Keep your commit message lines length less than 72 charcters as standard practice * It is perfectly ok - and even recommended - to write multiline commit messages +* Good practice is to make sure your commit messages are clear about what changed in the commit, this makes it easier to roll back to earlier versions if you break your code. * You can also refer to other issues or pull requests in your commit message. GitHub allocated a number reference to all pull requests and issues, so for example if you want to refer to pull request #788 simply do so in either the subject-line or in the body text as appropriate #### The --amend Option