summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAndrew Godwin2022-11-24 11:20:45 -0700
committerAndrew Godwin2022-11-24 11:20:45 -0700
commit4c00e11d63c082b57c1aec8f7c3e58820b56674a (patch)
tree65b350d2078db53e93aee7f6593b29d1469db6e3 /CONTRIBUTING.md
parent0c8897a2b5fd9ee3a6d81c19f4c4fa37b2f9d37e (diff)
downloadtakahe-4c00e11d63c082b57c1aec8f7c3e58820b56674a.tar.gz
takahe-4c00e11d63c082b57c1aec8f7c3e58820b56674a.tar.bz2
takahe-4c00e11d63c082b57c1aec8f7c3e58820b56674a.zip
Add a few more release bits
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md65
1 files changed, 0 insertions, 65 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index ba7559b..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Contributing to Takahē
-
-## Getting Started
-
-Development can be done "bare metal" or with Docker. We'll describe both here.
-
-
-### Bare Metal
-
-Takahē requires Python 3.10 or above, so you'll need that first. Then, create and
-activate a virtual environment:
-
-```shell
-$ python3 -m venv .venv
-$ . .venv/bin/activate
-```
-
-You can install the development requirements:
-
-```shell
-$ pip install -r requirements-dev.txt
-```
-
-...and enable git commit hooks if you like:
-
-```bash
-$ pre-commit install
-```
-
-Finally, you can run the tests with PyTest:
-
-```bash
-$ pytest
-```
-
-
-### Docker
-
-The docker build process will take care of much of the above, but you just have
-to be sure that you're executing it from the project root.
-
-First, you need to build your image:
-
-```shell
-$ docker build -f ./docker/Dockerfile -t "takahe:latest" .
-```
-
-Then start the `compose` session:
-
-```shell
-$ docker compose -f docker/docker-compose.yml up
-```
-
-Once your session is up and running, you can run the tests inside your
-container:
-
-```shell
-$ docker compose -f docker/docker-compose.yml exec web 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/).