From d4cdc511aec425701894a1a93633d8ac7ab98ee7 Mon Sep 17 00:00:00 2001 From: Joseph Hale Date: Thu, 9 Jan 2025 10:12:09 -0700 Subject: [PATCH] docs: Add contributing instructions --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ad61f05 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ + + +# Contributing + +## Environment Setup + +**Install Poetry** + +This project uses Poetry for dependency management and for publishing to PyPI. + +```bash +curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.8.5 python3 - +``` + +OR choose another [installation method from Poetry's website](https://python-poetry.org/docs/#installing-with-the-official-installer). + +**Install Dependencies** + +```bash +poetry shell +poetry install +``` + + +## Running Tests + +```bash +poetry run pytest +``` + -- 2.51.2