From bed8e1ba80c73b1d976ec865756b62e66342ce32 Mon Sep 17 00:00:00 2001 From: Max Wittig Date: Sat, 15 Dec 2018 11:38:41 +0100 Subject: [PATCH] docs(readme): provide commit message guidelines Fixes #660 --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index bed7f0eee..393398ef5 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 `_. +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