From 15a85bb87318cd5752ba1a5fed94a67ef4a608c0 Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Mon, 19 Jun 2017 12:02:12 +0200 Subject: [PATCH] Commit style docs --- doc/development/contribution/style.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/development/contribution/style.rst b/doc/development/contribution/style.rst index 20b5c02210..ed4776288b 100644 --- a/doc/development/contribution/style.rst +++ b/doc/development/contribution/style.rst @@ -20,6 +20,9 @@ Coding style and quality test suite are in the style of Python's unit test module. If you extend those files, you might continue in this style, but please use pytest style for any new test files. +* Please keep the first line of your commit messages short. When referencing an issue, please phrase it like + ``Fix #123 -- Problems with order creation`` or ``Refs #123 -- Fix this part of that bug``. + .. _PEP 8: http://legacy.python.org/dev/peps/pep-0008/ .. _flake8: https://pypi.python.org/pypi/flake8