From be409ff82572aeabe2387837624f47f6fb09f149 Mon Sep 17 00:00:00 2001
From: Peter Magnusson <me@kmpm.se>
Date: Wed, 1 Jun 2022 16:06:42 +0200
Subject: [PATCH] docs: notes about test and lint

---
 DEVELOP.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/DEVELOP.md b/DEVELOP.md
index e0844a5..7812405 100644
--- a/DEVELOP.md
+++ b/DEVELOP.md
@@ -16,6 +16,26 @@ python3 -m venv venv
 pip install -e .[dev]
 ```
 
+# Test
+Before you commit any code you should preferably run...
+```shell
+make lint
+make test
+```
+
+## Live Testing
+If you have a domain to play around with there is a way of running a live test.
+You must create the `credentials.ini` file in the project root with the correct credentials.
+```shell
+# set some variables that are used
+export EMAIL=<your email address>
+export TESTDOMAIN=<yourdomain.com>
+
+
+# run the live tests that will be using your email and test.sub.$TESTDOMAIN
+make livetest
+```
+
 
 
 # Publish
@@ -58,4 +78,4 @@ twine upload -r testpypi dist/*
 # upload to production pypi, this will also require maintainer access
 twine upload dist/*
 
-```
\ No newline at end of file
+```