summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorMax Wittig <max.wittig95@gmail.com>2018-12-15 11:38:41 +0100
committerGitHub <noreply@github.com>2018-12-15 11:38:41 +0100
commitbed8e1ba80c73b1d976ec865756b62e66342ce32 (patch)
tree897e3dfd1c1b389e0b6825700fbc96b85e226bd9 /README.rst
parent9be82e1dfc77010fa9b4c1b6313abae519a00ac4 (diff)
downloadgitlab-docs/commit-message.tar.gz
docs(readme): provide commit message guidelinesdocs/commit-message
Fixes #660
Diffstat (limited to 'README.rst')
-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