From 8a0bf3c25f2a07f012443337c3793a099306c742 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Tue, 17 Mar 2015 13:16:39 +0100 Subject: [PATCH] docs: Include commit message tips in the guidelines --- docs/contributing.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 1b3b1330..ecfaea90 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -98,7 +98,19 @@ Pull request guidelines #. Feel free to include a changelog entry in your pull request. The changelog is in :file:`docs/changelog.rst`. -#. Write good commit messages. Here's three blog posts on how to do it right: +#. Write good commit messages. + + - Follow the template "topic: description" for the first line of the commit + message, e.g. "mpd: Switch list command to using list_distinct". See the + commit history for inspiration. + + - Use the rest of the commit message to explain anything you feel isn't + obvious. It's better to have the details here than in the pull request + description, since the commit message will live forever. + + - Write in the imperative, present tense: "add" not "added". + + For more inspiration, read these blog posts: - `Writing Git commit messages `_