Skip to content

Commit 58e5f4f

Browse files
paul1319crwilcox
authored andcommitted
docs(all): add commits convention description in CONTRIBUTING.rst (#9905)
* docs: add commits convention description in CONTRIBUTING.rst * docs: remove extra empty line in CONTRIBUTING.rst * docs: remove excess lines in CONTRIBUTING.rst
1 parent be2bd9f commit 58e5f4f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,15 @@ Exceptions to PEP8:
151151
"Function-Under-Test"), which is PEP8-incompliant, but more readable.
152152
Some also use a local variable, ``MUT`` (short for "Module-Under-Test").
153153

154+
*************************
155+
Commit Message Convention
156+
*************************
157+
158+
We use `Conventional Commits`_ as a convention for writing commit messages.
159+
It provides an easy set of rules for creating an explicit commit history.
160+
161+
.. _Conventional Commits: https://www.conventionalcommits.org/
162+
154163
********************
155164
Running System Tests
156165
********************

0 commit comments

Comments
 (0)