summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
blob: 7c77767aca7069923576c5ed8eb3ae33de4868a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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/).