Skip to content

Commit

Permalink
docs(all): add commits convention description in CONTRIBUTING.rst (#9905
Browse files Browse the repository at this point in the history
)

* docs: add commits convention description in CONTRIBUTING.rst

* docs: remove extra empty line in CONTRIBUTING.rst

* docs: remove excess lines in CONTRIBUTING.rst
  • Loading branch information
paul1319 authored and crwilcox committed Dec 6, 2019
1 parent be2bd9f commit 58e5f4f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,15 @@ Exceptions to PEP8:
"Function-Under-Test"), which is PEP8-incompliant, but more readable.
Some also use a local variable, ``MUT`` (short for "Module-Under-Test").

*************************
Commit Message Convention
*************************

We use `Conventional Commits`_ as a convention for writing commit messages.
It provides an easy set of rules for creating an explicit commit history.

.. _Conventional Commits: https://www.conventionalcommits.org/

********************
Running System Tests
********************
Expand Down

0 comments on commit 58e5f4f

Please sign in to comment.