summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAvi Flax2022-12-04 11:35:33 -0500
committerGitHub2022-12-04 09:35:33 -0700
commit45b91e1a0ec3eea6305b7164057ed82845b5a8bb (patch)
tree819f29c84f40d38a54ba7d899da93a34f7f05d70 /docs
parent61c1058d67ae5621687a95fbc1f6dcc71fbc42a7 (diff)
downloadtakahe-45b91e1a0ec3eea6305b7164057ed82845b5a8bb.tar.gz
takahe-45b91e1a0ec3eea6305b7164057ed82845b5a8bb.tar.bz2
takahe-45b91e1a0ec3eea6305b7164057ed82845b5a8bb.zip
Tweak Contributing docs to help people run the tests
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 49e53ed..46002bf 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -54,11 +54,17 @@ Then start the ``compose`` session::
At this point, you should be able to see the Web UI at http://localhost:8000
-Once your session is up and running, you can make yourself a superuser account::
+Once your session is up and running, you can:
+
+…make yourself a superuser account::
docker compose -f docker/docker-compose.yml exec web python3 manage.py createsuperuser
-And you can run the tests inside your container::
+…install the test dependencies inside your container::
+
+ docker compose -f docker/docker-compose.yml exec web pip install -r requirements-dev.txt
+
+…run the tests inside your container::
docker compose -f docker/docker-compose.yml exec web pytest