diff options
author | Bjørn Erik Pedersen <[email protected]> | 2016-03-11 10:29:04 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <[email protected]> | 2016-03-11 10:30:17 +0100 |
commit | 077b0fa71fee0e3eb848f59278fafe48745f04f1 (patch) | |
tree | b15f748af3092cd0459b1d550c4e9bbcb31144e0 /CONTRIBUTING.md | |
parent | 0667d8a0f5e98a069a069be79821da573f4e14fc (diff) | |
download | hugo-077b0fa71fee0e3eb848f59278fafe48745f04f1.tar.gz hugo-077b0fa71fee0e3eb848f59278fafe48745f04f1.zip |
Add package prefix to the commit message guidelines
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45d78c63e..f1c060cae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,5 +19,5 @@ To make the process as seamless as possible, we ask for the following: * Have test cases for the new code. If you have questions about how to do it, please ask in your pull request. * Run `go fmt` * Squash your commits into a single commit. `git rebase -i`. It’s okay to force update your pull request. - * **Write a good commit message.** 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*. + * **Write a good commit message.** 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." * Make sure `go test ./...` passes, and `go build` completes. Our [Travis CI loop](https://travis-ci.org/spf13/hugo) (Linux and OS X) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will catch most things that are missing. |