Contributing Guidelines#

Contributing to pychum#

Getting Started#

1. Fork and Clone#

git clone https://github.com/your-username/pychum
cd pychum

2. Set Up Environment#

uv sync --all-extras

3. Run Tests#

uv run pytest

Code Style#

Formatting#

uv run ruff format .
uv run ruff check .

Adding New Engines#

Directory Structure#

pychum/engine/<code>/
|-- __init__.py
|-- _dataclasses.py
|-- _renderer.py
`-- test_renderer.py

Pull Request Process#

  1. Create branch

  2. Add tests

  3. Run CI checks

  4. Submit PR

See Also#