This repository has been archived on 2023-09-24. You can view files and clone it, but cannot push or open issues or pull requests.
takahe/CONTRIBUTING.md
2022-11-13 13:57:27 -07:00

36 lines
552 B
Markdown

# 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/).