summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSebastian Thiel <sebastian.thiel@icloud.com>2022-05-18 07:53:43 +0800
committerSebastian Thiel <sebastian.thiel@icloud.com>2022-05-18 07:53:43 +0800
commitb4b238057e7913c93245b484bdd50131dafd71f3 (patch)
treea3394cfe902ce7edd07c89420c21c13274a2d295 /README.md
parenta7c5d887e943aa51f2270e517954c024a8c01500 (diff)
downloadgitpython-b4b238057e7913c93245b484bdd50131dafd71f3.tar.gz
Revert "Remove flake8 linting in favor of `black` formatting"
This reverts commit a7c5d887e943aa51f2270e517954c024a8c01500.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0709b796..54a735e5 100644
--- a/README.md
+++ b/README.md
@@ -107,13 +107,15 @@ with MINGW's.
Ensure testing libraries are installed.
In the root directory, run: `pip install -r test-requirements.txt`
+To lint, run: `flake8`
+
To typecheck, run: `mypy -p git`
To test, run: `pytest`
-Configurations for mypy, pytest and coverage.py are in ./pyproject.toml.
+Configuration for flake8 is in the ./.flake8 file.
-Run `black` for formatting.
+Configurations for mypy, pytest and coverage.py are in ./pyproject.toml.
The same linting and testing will also be performed against different supported python versions
upon submitting a pull request (or on each push if you have a fork with a "main" branch and actions enabled).