3.2 KiB
Developing Audita
Audita is a Go CLI for transcript polishing. Start with the README for product orientation and the internal overview for the implemented component map.
Before Changing the Repository
Coding agents must read and follow the agent policy before recommending, planning, or implementing changes. Read the architecture policy for boundaries and invariants, then use the task guide below rather than reading every reference indiscriminately.
Confirm the requested scope and behavior contract, make focused changes in the owning component, and update the relevant tests and canonical documentation when behavior changes. The testing policy governs test sufficiency; the documentation policy governs content ownership. Commit discipline and agent Git restrictions are in the agent policy.
Baseline Validation
Use Go 1.24 or newer. From the repository root:
go build -o ./bin/audita ./cmd/audita
go test ./...
Run targeted package tests for touched behavior and the complete suite for
substantial changes. Documentation-only work normally needs affected-link,
example, and whitespace checks; use git diff --check. Detailed component
validation belongs with the change recipes below.
Task-Specific Reading Guide
| Task | Read |
|---|---|
| Locate components or change orchestration | Internal overview, then pipeline |
| Change configuration or CLI behavior | Configuration contract, CLI contract, and configuration/CLI change recipes |
| Change modules or validators | Modules or validators; follow their prompt, registry, and test references |
| Change LLM transport or concurrency | LLM integration contract, LLM runtime, and pipeline |
| Change prompts | Prompt registry and the consuming module or validator |
| Change input/output formats | Input file contracts, output-file contract, encoder internals, and configuration |
| Change reports or diagnostics | Operations, output-file contract, subprocess integration, and diagnostics/reporting internals |
| Change tests | Testing policy and the affected component's internal documentation |
| Change docs or examples | Documentation policy, the canonical topic owner, and example validation |
| Prepare a release | Release policy and release procedure |
| Record a significant architectural decision | ADR lifecycle and ADR index |