Document agent skills and repository context sources
This commit is contained in:
@@ -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.
|
||||
@@ -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/<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`, 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/<feature-slug>/`.
|
||||
|
||||
## When a skill says "fetch the relevant ticket"
|
||||
|
||||
Read the referenced markdown path.
|
||||
Reference in New Issue
Block a user