summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvainpocentek@gmail.com>2018-12-16 09:13:50 +0100
committerGitHub <noreply@github.com>2018-12-16 09:13:50 +0100
commit85ac10200805de480a076760368336c8135e5acf (patch)
tree897e3dfd1c1b389e0b6825700fbc96b85e226bd9
parent9be82e1dfc77010fa9b4c1b6313abae519a00ac4 (diff)
parentbed8e1ba80c73b1d976ec865756b62e66342ce32 (diff)
downloadgitlab-85ac10200805de480a076760368336c8135e5acf.tar.gz
Merge pull request #664 from python-gitlab/docs/commit-message
docs(readme): provide commit message guidelines
-rw-r--r--README.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index bed7f0e..393398e 100644
--- a/README.rst
+++ b/README.rst
@@ -91,6 +91,9 @@ You can contribute to the project in multiple ways:
* Add unit and functional tests
* Everything else you can think of
+We prefer commit messages to be formatted using the `conventional-changelog <https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines>`_.
+This leads to more readable messages that are easy to follow when looking through the project history.
+
Provide your patches as github pull requests. Thanks!
Running unit tests