aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2022-04-25 07:23:46 +0300
committerFrederick Muriuki Muriithi2022-04-25 07:23:46 +0300
commit043d83d1cadd5b5abfa418ac02773c7a979c611d (patch)
tree0dc34379cb97e0b6501bb395800fbfae2f998553
parent0bc9f7db2b82bd446e79bdefb03a20516fe3d8b8 (diff)
downloadgn-uploader-043d83d1cadd5b5abfa418ac02773c7a979c611d.tar.gz
docs: update documentation on checks
-rw-r--r--README.org13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.org b/README.org
index 6210c08..aef1a08 100644
--- a/README.org
+++ b/README.org
@@ -37,10 +37,19 @@ To launch a guix shell for development, do:
to get an environment that is isolated from the rest of your system.
-*** Tests
+*** Checks
Run tests with:
-
#+BEGIN_SRC shell
pytest
#+END_SRC
+
+To run the linter over the code base, run:
+#+BEGIN_SRC shell
+ pylint tests quality_control qc_app
+#+END_SRC
+
+To check for correct type usage in the application, run:
+#+BEGIN_SRC shell
+ mypy --show-error-codes .
+#+END_SRC