Skip to content

contributing.md

Latest commit

 

History

History
67 lines (48 loc) · 1.58 KB

contributing.md

File metadata and controls

67 lines (48 loc) · 1.58 KB

Contributing

Development Setup

# Clone the repository
git clone https://github.com/tlancaster6/aquapose.git
cd aquapose

# Install Hatch (build/environment manager)
pip install hatch

# Create the default development environment
hatch env create

# Install pre-commit hooks
hatch run pre-commit install
hatch run pre-commit install --hook-type pre-push

Running Tests

hatch run test                                    # fast tests (skip @pytest.mark.slow)
hatch run test-all                                # all tests
hatch run pytest tests/unit/test_smoke.py -v     # single file

Code Quality

This project uses Ruff for linting and formatting:

hatch run lint                # lint
hatch run lint -- --fix       # lint + auto-fix
hatch run format              # format

Type Checking

This project uses basedpyright for type checking:

hatch run typecheck           # run type checker
hatch run check               # lint + typecheck

Pre-commit hooks run Ruff automatically on each commit. Pre-push hooks run the full linter and formatter check.

Commit Messages

Use Conventional Commits:

  • feat: -- new feature (triggers minor version bump)
  • fix: -- bug fix (triggers patch version bump)
  • docs: -- documentation only
  • test: -- adding or updating tests
  • refactor: -- code restructuring without behavior change
  • ci: -- CI/CD changes
  • chore: -- maintenance tasks

Building Documentation

hatch run docs:build