add hints on black code style
This commit is contained in:
parent
0bdd246e02
commit
8b1fb29905
@ -17,23 +17,20 @@ Author-list
|
|||||||
|
|
||||||
This project keeps a list of authors. This can be auto-generated by calling `./doc/generate-authors.sh`.
|
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.
|
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.
|
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 <https://git-scm.com/docs/git-shortlog#_mapping_authors>`_.
|
You can find a good documentation on the mapping-feature in the
|
||||||
|
`documentation of git-shortlog <https://git-scm.com/docs/git-shortlog#_mapping_authors>`_.
|
||||||
|
|
||||||
Style-Guide
|
Style-Guide
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
When writing code please try to stick to these rules.
|
When writing code please try to stick to these rules.
|
||||||
|
|
||||||
PEP8
|
Black Code Style
|
||||||
^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
The entire codebase adheres to the rules of PEP8.
|
This project is formatted with the auto formatter black.
|
||||||
These rules are enforced by running `flake8` in the integration-checks.
|
Please format your contributions with black, otherwise they will be rejected.
|
||||||
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.
|
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
^^^
|
^^^
|
||||||
|
Loading…
x
Reference in New Issue
Block a user