diff options
| author | digitalcraftsman <digitalcraftsman@users.noreply.github.com> | 2016-11-04 21:37:41 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-11-04 21:37:41 +0300 |
| commit | f4afd13386f16198f01a929c9dfba0353c605251 (patch) | |
| tree | bde41b991fab9f9ead51303607de662913f7a2e2 /CONTRIBUTING.md | |
| parent | ec44ad5c0b09e9f3915d5291bd7f680f7a258890 (diff) | |
Enhance commit message guidelines
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8dff7293d..40bf91ac1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 |