4.6 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. Use the policy reading guide below to select the policies applicable to the task.
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.
Policy Reading Guide
| Policy | Read before… |
|---|---|
| Policy set provenance | Adopting policies, checking upstream revisions, or updating the adopted policy set. |
| Agents | Recommending, planning, or implementing repository changes. |
| Architecture | Planning or changing application code or its structure. |
| Testing | Selecting validation for code changes, or adding, changing, removing, or evaluating tests. |
| Documentation | Writing, revising, or reorganizing documentation. |
| OSS | Adding or updating dependencies or incorporated third-party material, or changing licensing or attribution. |
| Release | Preparing or publishing a release, changing release procedures, or making versioning and compatibility decisions. |
- Read applicable policies before making decisions they govern; multiple policies may apply.
- Select policies using the task triggers above. Follow cross-references to relevant sections when needed to resolve a concrete question.
- Reuse policies already available in context; reread when changed or no longer available.
- Expand reading when the task's scope expands.
- When revising a policy itself, read that policy and any provisions elsewhere affected by the revision.
Baseline Validation
Use Go 1.26.0 or newer for source builds. The selected release toolchain is documented in the release procedure. 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 |