From d88ef631a78c32baed34a126d79f4679a2f09d10 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Mon, 7 Aug 2023 12:22:55 +0300
Subject: Add documentation on expected checks.

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'README.md')

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
+```
-- 
cgit v1.2.3