aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2023-08-07 12:22:55 +0300
committerFrederick Muriuki Muriithi2023-08-07 12:29:09 +0300
commitd88ef631a78c32baed34a126d79f4679a2f09d10 (patch)
treefa98d5125cb5d8c82e6bd0669853cb186301978a
parent91061a7b4af2aaa7c7c97d0cd215a0dc28a42419 (diff)
downloadgn-auth-d88ef631a78c32baed34a126d79f4679a2f09d10.tar.gz
Add documentation on expected checks.
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7bf6f9c..f076ce1 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,26 @@
This project is for the GeneNetwork Authentication/Authorisation server to be
used across the entire suite of the GeneNetwork services.
+
+
+
+## Checks
+
+### Linting
+
+```bash
+pylint *py tests gn3 scripts
+```
+
+### Type-Checking
+
+```bash
+mypy --show-error-codes .
+```
+
+### Running Tests
+
+```bash
+export AUTHLIB_INSECURE_TRANSPORT=true
+pytest -k unit_test
+```