chore: add CONTRIBUTING.md, allow running pytest directly in dev

adfinis · Apr 16, 2024 · 146bc35 · 146bc35
1 parent a6b445d
commit 146bc35
Show file tree

Hide file tree

Showing 3 changed files with 840 additions and 128 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# Contributing guide
+
+To contribute to this project, you'll need [Poetry](https://python-poetry.org/).
+
+```sh
+poetry install --with dev
+
+# run tests
+poetry run pytest
+```
+
+We're also using [tox](https://tox.wiki/en/4.14.2/) to run the tests in all supported environments. Running the full test suite is simple:
+
+```sh
+tox
+```
+
+If you'd like to run tests in a specific environment, use `-e`:
+```sh
+tox -e django42
+```