Project Name

One-line description of what this project does.

First time? Start with SETUP.md

If you just cloned or forked this template, follow the checklist in SETUP.md to configure the repo for your project. Delete it when done.

Quickstart

# Install dependencies
# EDIT: Add your install command

# Run the full verification pipeline
make verify

# Run just the tests
make test

For AI coding agents

This repository is structured for agent-first development. Start here:

• All agents: Read AGENTS.md
• Claude Code: Read CLAUDE.md
• Cursor: Rules in .cursor/rules/
• Copilot: Instructions in .github/copilot-instructions.md

Documentation

Document	What it covers
docs/ARCHITECTURE.md	System map, layers, dependency rules
docs/CONVENTIONS.md	Code style, naming, patterns
docs/BELIEFS.md	Engineering principles and rationale
docs/QUALITY.md	Quality grades by domain
docs/GLOSSARY.md	Domain terms → code mapping
docs/adr/	Architecture Decision Records

Project structure

src/             # Source code (structure per docs/ARCHITECTURE.md)
tests/           # Test suite (structure per docs/CONVENTIONS.md)
docs/            # Architecture, conventions, ADRs, glossary
scripts/         # Build and maintenance scripts

See docs/ARCHITECTURE.md for structural guidance and recommended patterns.

Available commands

Run make help to see all available commands.

License