55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
|
{{ conventions }}
|
||
|
|
|
||
|
|
## Task
|
||
|
|
|
||
|
|
Review this repository, register it, and sharpen its open questions.
|
||
|
|
|
||
|
|
### 1. Review it first
|
||
|
|
|
||
|
|
Read the intent, the specification or design documents, the implementation, and
|
||
|
|
the tests. Run the tests and any example or smoke path — a review that has not
|
||
|
|
executed anything is a reading, not a review.
|
||
|
|
|
||
|
|
Report what you actually found: what works, what is specified but unimplemented,
|
||
|
|
what is implemented but unspecified, and any defect you can demonstrate. Cite
|
||
|
|
`file:line` for each defect and say what input triggers it. Do not pad the list
|
||
|
|
with style preferences.
|
||
|
|
|
||
|
|
### 2. Register it
|
||
|
|
|
||
|
|
Register the repo through the sanctioned path for this fleet, then replace the
|
||
|
|
generated placeholders with facts: real boundaries in `SCOPE.md`, the real
|
||
|
|
developer workflow, and a classification that matches what the repo is.
|
||
|
|
|
||
|
|
If the generator leaves an unresolved template token or other defect, fix it
|
||
|
|
locally and report it — it probably affects every repo registered with that
|
||
|
|
template version.
|
||
|
|
|
||
|
|
### 3. Refine the open questions
|
||
|
|
|
||
|
|
Find the questions this repo has deferred — a spec's "open questions" section, a
|
||
|
|
TODO that encodes a decision, a field that is declared but unspecified. For each,
|
||
|
|
work out what is actually at stake: what breaks if it stays unanswered, and
|
||
|
|
which answers would lead to materially different work.
|
||
|
|
|
||
|
|
Interview: **{{ interview }}**.
|
||
|
|
|
||
|
|
When interviewing, ask only about decisions that are genuinely the operator's —
|
||
|
|
where the codebase, the intent document and sensible defaults do not settle it.
|
||
|
|
Give each question a recommendation and say why. Do not ask about things you can
|
||
|
|
determine by reading. Do not ask a question whose answer is already written in
|
||
|
|
the repo's own documents; check first.
|
||
|
|
|
||
|
|
When not interviewing, decide on stated assumptions and mark each clearly as an
|
||
|
|
assumption to be confirmed.
|
||
|
|
|
||
|
|
### 4. Record it
|
||
|
|
|
||
|
|
Capture the refined questions as a workplan file in the repo — one task per
|
||
|
|
question, each with the scoped question and a stated leaning — then sync. Leave
|
||
|
|
the workplan `proposed` rather than `ready` unless it has been reviewed against
|
||
|
|
the current repo state.
|
||
|
|
|
||
|
|
Close with a progress event naming what you reviewed, what you registered, and
|
||
|
|
what remains open.
|