diff options
author | Michael Manfre | 2022-11-13 15:57:27 -0500 |
---|---|---|
committer | GitHub | 2022-11-13 13:57:27 -0700 |
commit | 5a8b6bb3d022a532562ad5fa6d629cfc48c51b46 (patch) | |
tree | 3e47d556e393d707b9ffe4a457e93e9f8b4b2d8a /CONTRIBUTING.md | |
parent | 30c208226e8eedeb6879f0b771ae9d5987d06aec (diff) | |
download | takahe-5a8b6bb3d022a532562ad5fa6d629cfc48c51b46.tar.gz takahe-5a8b6bb3d022a532562ad5fa6d629cfc48c51b46.tar.bz2 takahe-5a8b6bb3d022a532562ad5fa6d629cfc48c51b46.zip |
Improving contributing docs/process
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 35 |
1 files changed, 35 insertions, 0 deletions
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/). |