diff --git a/AGENTS.md b/AGENTS.md index c9c4c66..23804d2 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -19,3 +19,13 @@ If you're using Codex or another agent-capable tool, additional project-scoped h Managed by Trellis. Edits outside this block are preserved; edits inside may be overwritten by a future `trellis update`. + +## Agent skills + +### Issue tracker + +Issues and specs for this repo live as markdown files under `.scratch/`. See `docs/agents/issue-tracker.md`. + +### Domain docs + +This is a single-context repo. Domain context lives in root `CONTEXT.md` when present, and architectural decisions live in `docs/adr/`. See `docs/agents/domain.md`. diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 0000000..931f371 --- /dev/null +++ b/docs/agents/domain.md @@ -0,0 +1,24 @@ +# Domain Docs + +Before exploring a topic, read `CONTEXT.md` at the repo root when it exists, then read the relevant ADRs under `docs/adr/`. + +Missing context files should be ignored silently. Create `CONTEXT.md` lazily only when domain terminology or a durable decision needs to be recorded. + +## File structure + +This repository uses a single-context layout: + +```text +/ +├── CONTEXT.md +├── docs/adr/ +└── src/ +``` + +## Vocabulary + +Use the project's established domain terms in issue titles, proposals, tests, and documentation. If a term is unclear or missing, treat it as a signal to clarify the domain model rather than inventing a synonym. + +## ADR conflicts + +If a proposal contradicts an existing ADR, call out the conflict explicitly instead of silently overriding it. diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md new file mode 100644 index 0000000..ce2b6bc --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,19 @@ +# Issue tracker: Local Markdown + +Issues and specs for this repo live as markdown files in `.scratch/`. + +## Conventions + +- One feature per directory: `.scratch//` +- The spec is `.scratch//spec.md` +- Implementation issues are one file per ticket at `.scratch//issues/-.md`, numbered from `01`. +- A ticket may include a `Status:` line near the top, using a simple project-defined state such as `open`, `in-progress`, `blocked`, or `done`. +- Comments and conversation history append to the bottom under a `## Comments` heading. + +## When a skill says "publish to the issue tracker" + +Create a new file under `.scratch//`. + +## When a skill says "fetch the relevant ticket" + +Read the referenced markdown path.