pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update doc for isort

Browse Source
This commit is contained in:
Bastien Gerard
2021-03-29 21:55:34 +02:00
parent ff596fcb7e
commit e5a2714baf
4 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.rst
View File

@@ -35,8 +35,8 @@ Travis runs the tests against the main Python 3.x versions.
Style Guide
-----------
MongoEngine's codebase is formatted with `black <https://github.com/python/black>`_, other tools like
flake8 are also used. Those tools will run as part of the CI and will fail in case the code is not formatted properly.
MongoEngine's codebase is auto-formatted with `black <https://github.com/python/black>`_, imports are ordered with `isort <https://pycqa.github.io/isort/>`_
and other tools like flake8 are also used. Those tools will run as part of the CI and will fail in case the code is not formatted properly.
To install all development tools, simply run the following commands:
@@ -58,6 +58,10 @@ To enable ``pre-commit`` simply run:
See the ``.pre-commit-config.yaml`` configuration file for more information
on how it works.
pre-commit will now run upon every commit and will reject anything that doesn't comply.
You can also run all the checks with ``pre-commit run -a``, this is what is used in the CI.
Testing
-------