aboutsummaryrefslogtreecommitdiff
path: root/STYLE
diff options
context:
space:
mode:
authorWilliam Hubbs <williamh@gentoo.org>2011-07-13 13:30:38 -0500
committerWilliam Hubbs <williamh@gentoo.org>2011-07-13 15:33:04 -0500
commit5541e5ba24532687ff490161ea9907382e88405e (patch)
tree7145e656a62aa1356e205e81e2ed7b29614e251c /STYLE
parenta74382d9cb3d7f024efca46f2befb49e35c40758 (diff)
Add commit message information to style guide
Diffstat (limited to 'STYLE')
-rw-r--r--STYLE51
1 files changed, 51 insertions, 0 deletions
diff --git a/STYLE b/STYLE
index f1ae5c1e..6be4a864 100644
--- a/STYLE
+++ b/STYLE
@@ -32,3 +32,54 @@ void foo(int c)
return ret;
}
+
+##################
+# COMMIT MESSAGES #
+##################
+
+The following is an example of a correctly formatted git commit message
+for this repository. Most of this information came from this blog post
+[1], so I would like to thank the author.
+
+### cut here ###
+Capitalized, short (50 chars or less) summary
+
+More detailed explanatory text, if necessary. Wrap it to about 72
+characters or so. In some contexts, the first line is treated as the
+subject of an email and the rest of the text as the body. The blank
+line separating the summary from the body is critical (unless you omit
+the body entirely); tools like rebase can get confused if you run the
+two together.
+
+Write your commit message in the present tense: "Fix bug" and not "Fixed
+bug." This convention matches up with commit messages generated by
+commands like git merge and git revert.
+
+Further paragraphs come after blank lines.
+
+- Bullet points are okay, too
+
+- Typically a hyphen or asterisk is used for the bullet, preceded by a
+ single space, with blank lines in between, but conventions vary here
+
+- Use a hanging indent
+
+Reported-by: User Name <email>
+X-[Distro]-Bug: BugID
+X-[Distro]-Bug-URL: URL for the bug (on the distribution's web site typically)
+### cut here ###
+
+If you did not write the code and the patch does not include authorship
+information in a format git can use, please use the --author option of the
+git commit command to make the authorship correct.
+
+The Reported-by tag is required if the person who reported the bug is
+different from the author and committer.
+
+ The X-[Distro]-Bug/Bug-URL tags are required if this commit is related
+ to a bug reported to us by a specific distribution of linux or a
+ *BSD. Also, [Distro] should be replaced with the name of the
+ distribution, e.g. X-Gentoo-Bug.
+
+[1] http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+