chore: initialize proxyctl specification
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# Domain Docs
|
||||
|
||||
How engineering skills should consume this repo's domain documentation.
|
||||
|
||||
## Before exploring, read these
|
||||
|
||||
- `CONTEXT.md` at the repo root
|
||||
- Relevant ADRs under `docs/adr/`
|
||||
|
||||
If these files do not exist, proceed silently. The domain-modeling flow creates
|
||||
them lazily when terms or decisions are resolved.
|
||||
|
||||
## File structure
|
||||
|
||||
This is a single-context repo:
|
||||
|
||||
```
|
||||
/
|
||||
├── CONTEXT.md
|
||||
├── docs/adr/
|
||||
└── src/
|
||||
```
|
||||
|
||||
## Use the glossary's vocabulary
|
||||
|
||||
Use terms as defined in `CONTEXT.md`. Do not drift to synonyms the glossary
|
||||
explicitly avoids.
|
||||
|
||||
If a needed concept is missing, reconsider whether new language is necessary or
|
||||
note the gap for `/domain-modeling`.
|
||||
|
||||
## Flag ADR conflicts
|
||||
|
||||
If proposed work contradicts an existing ADR, surface the conflict explicitly
|
||||
rather than silently overriding it.
|
||||
@@ -0,0 +1,30 @@
|
||||
# Issue tracker: Local Markdown
|
||||
|
||||
Issues and specs for this repo live as Markdown files in `.scratch/`.
|
||||
|
||||
## Conventions
|
||||
|
||||
- One feature per directory: `.scratch/<feature-slug>/`
|
||||
- The spec is `.scratch/<feature-slug>/spec.md`
|
||||
- Implementation issues are one file per ticket at
|
||||
`.scratch/<feature-slug>/issues/<NN>-<slug>.md`
|
||||
- Tickets are numbered from `01`
|
||||
- Comments and conversation history are appended under `## Comments`
|
||||
|
||||
## When a skill says "publish to the issue tracker"
|
||||
|
||||
Create a new file under `.scratch/<feature-slug>/`, creating the directory if needed.
|
||||
|
||||
## When a skill says "fetch the relevant ticket"
|
||||
|
||||
Read the referenced file. The user will normally provide its path or issue number.
|
||||
|
||||
## Wayfinding operations
|
||||
|
||||
- Map: `.scratch/<effort>/map.md`
|
||||
- Child ticket: `.scratch/<effort>/issues/NN-<slug>.md`
|
||||
- `Type:` records `research`, `prototype`, `grilling`, or `task`
|
||||
- `Status:` records `claimed` or `resolved`
|
||||
- `Blocked by: NN, NN` declares blocking relationships
|
||||
- Claim a ticket by setting `Status: claimed`
|
||||
- Resolve it by adding `## Answer`, setting `Status: resolved`, and updating the map
|
||||
Reference in New Issue
Block a user