Skip to content

Commit d6d73ca

Browse files
authored
Added commit message style in development.rst (#286)
We documented the style of the commit message for the future developers. Fixes #270.
1 parent 8bf76f3 commit d6d73ca

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/source/development.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,17 @@ Development
3939
.. code-block:: bash
4040
4141
./precommit.py --overwrite
42+
43+
44+
Commit Message Style
45+
--------------------
46+
47+
Use the following guidelines for commit message.
48+
49+
* Past tense in the subject & body
50+
* Max. 50 characters subject
51+
* Max. 72 characters line length in the body (multiple lines are ok)
52+
* Past tense in the body
53+
* Have separate commits for the releases where the important changes are highlighted
54+
55+
See examples from past commits at https://github.com/Parquery/icontract/commits/master/

0 commit comments

Comments
 (0)