Skip to content

Commit

Permalink
Added commit message style in development.rst (#286)
Browse files Browse the repository at this point in the history
We documented the style of the commit message for 
the future developers.

Fixes #270.
  • Loading branch information
simkimsia authored Dec 27, 2023
1 parent 8bf76f3 commit d6d73ca
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,17 @@ Development
.. code-block:: bash
./precommit.py --overwrite
Commit Message Style
--------------------

Use the following guidelines for commit message.

* Past tense in the subject & body
* Max. 50 characters subject
* Max. 72 characters line length in the body (multiple lines are ok)
* Past tense in the body
* Have separate commits for the releases where the important changes are highlighted

See examples from past commits at https://github.com/Parquery/icontract/commits/master/

0 comments on commit d6d73ca

Please sign in to comment.