From 5a8b6bb3d022a532562ad5fa6d629cfc48c51b46 Mon Sep 17 00:00:00 2001
From: Michael Manfre
Date: Sun, 13 Nov 2022 15:57:27 -0500
Subject: Improving contributing docs/process

---
 CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 CONTRIBUTING.md

(limited to 'CONTRIBUTING.md')

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/).
-- 
cgit v1.2.3