Skip to content

docs(all): add commits convention description in CONTRIBUTING.rst #9905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crwilcox merged 3 commits into from
Dec 6, 2019
Merged

docs(all): add commits convention description in CONTRIBUTING.rst #9905

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b94dace
docs: add commits convention description in CONTRIBUTING.rst
paul1319 Nov 27, 2019
90e3de9
docs: remove extra empty line in CONTRIBUTING.rst
paul1319 Nov 27, 2019
ba014d0
docs: remove excess lines in CONTRIBUTING.rst
paul1319 Nov 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
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