Contributing

This page summarizes the contribution path for stacksats. Upstream docs remain canonical for full requirements.

Contribution Path

1. Create a feature branch from main.
2. Make focused changes with tests where practical.
3. Update docs and changelog entries for user-visible changes.
4. Open a pull request with clear test evidence.

Condensed Local Setup

python -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -e ".[dev]"
pip install pre-commit
venv/bin/python -m pre_commit install -t pre-commit

Condensed Local Checks

venv/bin/python -m ruff check .
venv/bin/python -m pytest -q
venv/bin/python -m mkdocs build --strict

Canonical Contribution Docs

• CONTRIBUTING.md
• Code of Conduct
• Hosted docs
• GitHub Issues