my-project

Replace with a one-sentence description of the project.

Quick start

# Install uv if missing
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install dependencies and git hooks
make install

# Verify everything is in order
make ci

Architecture

The project follows Vertical Slice Architecture combined with hexagonal principles. Each feature is self-contained in its own slice.

src/my_project/
├── examples/       ← feature slice: entity, port, use cases, repository adapter
├── shared/         ← shared kernel: Value Objects, base exceptions
└── infrastructure/ ← cross-cutting: config, logging, correlation ID

Architectural decisions are documented in docs/adr/.

Commands

make help       # list all available commands

make install    # install dependencies and git hooks
make check      # lint + format + types + security (mirrors CI)
make test       # tests + coverage (threshold: 80%)
make ci         # run the full CI pipeline locally
make benchmark  # performance benchmarks on the domain
make mutation   # mutation testing on the domain slice (slow)

Quality

Full quality strategy documented in QUALITY.md.

Step	Tools	Blocking
git commit	ruff, mypy, bandit	yes
git push	pytest (entity + use cases)	yes
CI — PR	lint, types, full tests, coverage ≥ 80%, pip-audit	yes
CI — PR → main	mutation testing (domain slice)	no

Contributing

See CONTRIBUTING.md.