From 57ab98ac5c4aa35dac7f6bada82f38b32d751f93 Mon Sep 17 00:00:00 2001 From: Paul McCarthy <pauldmccarthy@gmail.com> Date: Wed, 2 May 2018 11:00:43 +0100 Subject: [PATCH] DOC: Note about commit messages --- doc/contributing.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/contributing.rst b/doc/contributing.rst index 54816c0ef..5dee416cd 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -24,6 +24,26 @@ Development model - Coding conventions are adhered to (unless there is good reason not to). +Commit messages +--------------- + + +To aid readability, all commit messages should be prefixed with one or more of +the following labels (this convention has been inherited from `nibabel +<https://github.com/nipy/nibabel>`_): + + * *BF* : bug fix + * *RF* : refactoring + * *NF* : new feature + * *BW* : addresses backward-compatibility + * *OPT* : optimization + * *BK* : breaks something and/or tests fail + * *PL* : making pylint happier + * *DOC*: for all kinds of documentation related commits + * *TEST*: for adding or changing tests + * *MAINT*: for administrative/maintenance changes + + Version number -------------- -- GitLab