Permalink
Browse files

Enhance commit message guidelines

  • Loading branch information...
1 parent ec44ad5 commit f4afd13386f16198f01a929c9dfba0353c605251 @digitalcraftsman digitalcraftsman committed on GitHub Nov 4, 2016
Showing with 4 additions and 0 deletions.
  1. +4 −0 CONTRIBUTING.md
View
@@ -61,12 +61,16 @@ To make the contribution process as seamless as possible, we ask for the followi
This [blog article](http://chris.beams.io/posts/git-commit/) is a good resource for learning how to write good commit messages,
the most important part being that each commit message should have a title/subject in imperative mood starting with a capital letter and no trailing period:
*"Return error on wrong use of the Paginator"*, **NOT** *"returning some error."*
+
Also, if your commit references one or more GitHub issues, always end your commit message body with *See #1234* or *Fixes #1234*.
Replace *1234* with the GitHub issue ID. The last example will close the issue when the commit is merged into *master*.
+
Sometimes it makes sense to prefix the commit message with the packagename (or docs folder) all lowercased ending with a colon.
That is fine, but the rest of the rules above apply.
So it is "tpl: Add emojify template func", not "tpl: add emojify template func.", and "docs: Document emoji", not "doc: document emoji."
+Please consider to use a short and descriptive branch name, e.g. **NOT** "patch-1". It's very common but creates a naming conflict each time when a submission is pulled for a review.
+
An example:
```text

0 comments on commit f4afd13

Please sign in to comment.