summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7c77767
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+# Contributing to Takahē
+
+## Getting Started
+
+Takahē requires Python 3.11
+
+Create and activate a virtual environment
+
+```
+python3 -m venv .venv
+. .venv/bin/activate
+```
+
+Install the development requirements:
+
+```
+pip install -r requirements-dev.txt
+```
+
+Enable git commit hooks:
+
+```bash
+pre-commit install
+```
+
+Try running the tests:
+
+```bash
+pytest
+```
+
+# Code of Conduct
+
+As a contributor, you can help us keep the Takahē community open and inclusive. Takahē
+follows the [Django Project Code of Conduct](https://www.djangoproject.com/conduct/).