diff --git a/doc/contributing.rst b/doc/contributing.rst index 54816c0ef9875eeae23f8afbab900a358c11f9dc..5dee416cdfa12ee400e45ebe788a5da444f4c3b1 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 --------------