Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.19 KB
Raw

Getting Started

To run this code, you'll need to have Python 3.9, 3.10, 3.11, or 3.12 installed on your machine. You'll also need to install the required packages by running the following commands from inside the project folder:

pip install -U pip uv
uv venv
source .venv/bin/activate
uv pip install -e .[dev]
pre-commit install
python3 -m src.app

Code Submissions

Tests

Some parts of this module (mostly those involving list scanning) feature unit tests, so please run pytest in the project directory before committing.

Dependencies

If you add or modify any dependencies, be sure to list them in pyproject.toml. The optional dependency group [dev] is used for dependencies used by developers working on this codebase. The optional dependency group [github-actions] is used for dependencies used when testing or executing CI actions.

Style

If your text editor doesn't support .editorconfig, please reference the .editorconfig file for some basic formatting norms. Regardless, ruff format . should be run to standardize formatting before attempting to commit.