main
md 17 lines 768 Bytes
Rendered Raw
1 # Specs
2
3 Behavioural specifications for features in `sigit-si`. A spec describes the
4 contract a feature must satisfy: inputs, outputs, error cases, authorization,
5 and acceptance criteria. It is the source of truth for what the code is supposed
6 to do, independent of how it is implemented.
7
8 Conventions:
9
10 - One file per feature, kebab-cased (`mcp-server.md`).
11 - Front-matter carries `name`, `description`, `status`, and the implementing
12 paths so a reader can jump from contract to code.
13 - `status` is one of `draft`, `implemented`, or `deprecated`.
14 - Write to the same rules as the rest of this repo (see `../AGENTS.md`):
15 technical and neutral, no AI-writing tells, no em dashes.
16 - When behaviour changes, update the spec in the same change as the code.
17 </content>