Lines Matching +full:commit +full:- +full:message
1 Git commit messages format
4 The principle of the git commit log is to document at least the
5 *what*; in English. That is redundant with the commit diff, yes. But
6 that redundancy does help in understanding the commit diff better. If
7 appropriate, the commit log can also document the *why*, but only if
8 it does so by respecting the format of the commit log. The reason why
9 we are so strict about the format is that the commit log is later
15 The first line of a git commit message should start at column 1, with
17 commit. If the commit relates to a bug filed into bugzilla, the line
21 Bug <number-of-the-bug> This is a great commit
30 <white-space>*. That is, no line in that text should start with a
46 An example of commit message would be:
61 Note how, in the ChangeLog part of the commit log, each function
68 so there is no need to describe in the ChangeLog part of the commit
89 commit. It can contain whatever character I want. It just cannot
110 be generous :-)
112 And then the ChangeLog part of the commit log is another exercise.
117 Writing the ChangeLog part of the commit log can seem tedious, but
118 it's an excellent way to perform an auto-review of your work. You'd
122 function-by-function and line-by-line review of your changes, so
126 We encourage you to look at the existing commit logs or at the