Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (30 loc) · 906 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 906 Bytes

Contributing Guide

Thank you for considering a contribution.

Development setup

  1. Create and activate a virtual environment.
  2. Install editable package with development tools:
pip install -e .[dev]
  1. Run local checks before opening a pull request:
pytest
ruff check .
mypy src

Contribution workflow

  1. Open an issue describing the bug/feature.
  2. Create a branch from main.
  3. Add tests for behavior changes.
  4. Keep docs updated (README, LEARN, or docs files).
  5. Submit a pull request with clear summary and rationale.

Pull request expectations

  • New features include tests.
  • Breaking changes are explicitly documented.
  • Public interfaces include docstrings.
  • Configuration and artifact changes include migration notes.

Coding standards

  • Python 3.10+
  • Type hints on public APIs
  • Small functions and explicit names
  • Avoid hidden side effects