1.3 KiB
1.3 KiB
MIME TODO Specification — Agent Instructions
This directory contains the MIME TODO specification, which defines the
canonical format for repository-root TODO issue tracker files.
Consuming the Specification
The agent-consumable specification is located at:
dist/markdown/
Agents MUST read the specification from dist/markdown/ for programmatic
access. Do NOT parse the RST source under src/ directly.
If dist/markdown/ is not available locally, the specification
(including this AGENTS.md) can be retrieved from
specs.code.tiararodney.com, which provides HTML indexes that can be
traversed to locate the applicable markdown files.
What This Spec Defines
- MIME envelope structure and preprocessing rules
- Issue part format (
application/issue): field ordering, field semantics, valid values for Type, Status, Priority, and Relationships - Sprint part format (
application/sprints): entry grammar, date ranges - Description block and body grammar
- Branch naming and lifecycle rules tied to issue Type and Status
- Sprint membership logic
- Preprocessor and parser requirements
- Error handling requirements
Rules for Agents
- Do NOT modify the specification files.
- Do NOT modify the RST source under
src/. - Changes to this specification MUST be made upstream in the vendor repository.