From 8b1fb299054942938de874c8c911393384deb03f Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Thu, 18 May 2023 15:26:21 +0200 Subject: [PATCH] add hints on black code style --- CONTRIBUTING.rst | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 7f6b40f..c494134 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -17,23 +17,20 @@ Author-list This project keeps a list of authors. This can be auto-generated by calling `./doc/generate-authors.sh`. When contributing the first time, please include a commit with the output of this script in place. -Otherwise the integration-check will fail. When you change your username or mail-address, please also update the `.mailmap` and the authors-list. -You can find a good documentation on the mapping-feature in the `documentation of git-shortlog `_. +You can find a good documentation on the mapping-feature in the +`documentation of git-shortlog `_. Style-Guide ----------- When writing code please try to stick to these rules. -PEP8 -^^^^ -The entire codebase adheres to the rules of PEP8. -These rules are enforced by running `flake8` in the integration-checks. -Please adhere to these rules as your contribution can only be merged if the check succeeds. -You can use flake8 or similar tools locally in order to check your code. -Apart from that the travis-log and the check by Landscape will provide you with hints. +Black Code Style +^^^^^^^^^^^^^^^^ +This project is formatted with the auto formatter black. +Please format your contributions with black, otherwise they will be rejected. GIT ^^^