mirror of
https://github.com/jointakahe/takahe.git
synced 2024-11-22 15:21:01 +00:00
36 lines
552 B
Markdown
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/).
|