##// END OF EJS Templates
Updated dev docs with information about commit messages.
Fernando Perez -
Show More
@@ -40,13 +40,43 b' generating release notes is as painless and accurate as possible.'
40 committing something that is completely (or almost so) a third-party
40 committing something that is completely (or almost so) a third-party
41 contribution, do the commit as::
41 contribution, do the commit as::
42
42
43 $ git commit --author="Someone Else"
43 $ git commit --author="Someone Else <who@somewhere.com>"
44
44
45 This way it will show that name separately in the log, which makes it even
45 This way it will show that name separately in the log, which makes it even
46 easier to spot. Obviously we often rework third party contributions
46 easier to spot. Obviously we often rework third party contributions
47 extensively ,but this is still good to keep in mind for cases when we don't
47 extensively, but this is still good to keep in mind for cases when we don't
48 touch the code too much.
48 touch the code too much.
49
49
50
50
51 .. [Git] The Git version control system.
51 .. [Git] The Git version control system.
52 .. [Github.com] Github.com. http://github.com
52 .. [Github.com] Github.com. http://github.com
53
54
55 Commit messages
56 ===============
57
58 Good commit messages are very important; they provide a verbal account of what
59 happened that is often invaluable for anyone trying to undestand the intent of
60 a commit later on (including the original author!). And git's log command is a
61 very versatile and powerful tool, capable of extracting a lot of information
62 from the commit logs, so it's important that these logs actually have useful
63 information in them.
64
65 In short, a commit message should have the form::
66
67 One line summary.
68 <THIS LINE MUST BE LEFT BLANK>
69 More detailed description of what was done, using multiple lines and even
70 more than one paragraph if needed. For very simple commits this may not be
71 necessary, but non-trivial ones should always have it.
72
73 Closes gh-NNN. # if the commit closes issue NNN on github.
74
75 This format is understood by many git tools that expect a *single line*
76 summary, so please do respect it.
77
78 An excellent reference on commits message is `this blog post`_, please take a
79 moment to read it (it's short but very informative).
80
81 .. _this blog post: http://who-t.blogspot.com/2009/12/on-commit-messages.html
82
General Comments 0
You need to be logged in to leave comments. Login now