From 028c56b003c22150f674001982efaadac1ea2106 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 13 Apr 2013 13:25:50 +0200 Subject: [PATCH] docs: Add links to blog posts on commit messages --- docs/contributing.rst | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 215aea65..b8d2a6f3 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -27,8 +27,8 @@ Making changes 2. Install dependencies as described in the :ref:`installation` section. -3. Checkout a new branch (usually based on develop) and name it accordingly to - what you intend to do. +3. Checkout a new branch (usually based on ``develop``) and name it accordingly + to what you intend to do. - Features get the prefix ``feature/`` @@ -95,10 +95,22 @@ Submitting changes - One branch per feature or fix. Keep branches small and on topic. -- Follow the :ref:`style guide `_, especially make sure ``flake8`` +- Follow the :ref:`code style `, especially make sure ``flake8`` does not complain about anything. -- Send a pull request to the ``develop`` branch. +- Write good commit messages. Here's three blog posts on how to do it right: + + - `Writing Git commit messages + `_ + + - `A Note About Git Commit Messages + `_ + + - `On commit messages + `_ + +- Send a pull request to the ``develop`` branch. See the `GitHub pull request + docs `_ for help. Additional resources @@ -110,7 +122,4 @@ Additional resources - `Mailing List `_ -- `General GitHub documentation `_ - -- `GitHub pull request documentation - `_ +- `GitHub documentation `_