Update readme

openlawlibrary · Oct 9, 2019 · d317871 · d317871
1 parent a05b3ef
commit d317871
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,21 @@ Install extra dependencies when using _Yubikey_:
 pip install taf[yubikey]
 ```
 
+## Development Setup
+
+We are using [pre-commit](https://pre-commit.com/) to run _black_ code formatter, _flake8_ and _bandit_ code quality checks.
+
+```bash
+pip install -e .[dev]
+pip install -e .[test]
+
+pre-commit install # registers git pre-commit hook
+
+pre-commit run --all-files # runs code formatting and quality checks for all files
+```
+
+NOTE: For _Windows_ users: Open [settings.json](.vscode/settings.json) and replace paths.
+
 ## Running Tests
 
 To run tests with mocked Yubikey: