Files
roboco/docs/rag/workflows/qa-review.md
T

114 lines
3.6 KiB
Markdown
Raw Normal View History

# QA Review Workflow
2026-05-09 03:15:09 +02:00
## Preconditions
2026-05-09 03:15:09 +02:00
- Task is in `awaiting_qa` status
- The developer's PR is open (the choreographer opened it during their `open_pr(task_id)` call)
2026-05-09 03:15:09 +02:00
- You are not the original developer of the task (self-review guard)
2026-05-09 03:15:09 +02:00
## Steps
```python
2026-05-09 03:15:09 +02:00
# 1. Pick up an awaiting-QA task
give_me_work()
2026-05-09 03:15:09 +02:00
# 2. Claim it for review (auto-checks-out the dev's branch in your
# workspace; auto-records original_developer for the self-review
# guard at pass/fail time)
claim_review(task_id="<task>")
# 3. Inspect the diff (project_slug is optional — omit it and your
# own project is used)
roboco_git_diff()
roboco_git_log(branch="<dev's branch>")
# 4. Run the relevant suite
2026-05-09 03:15:09 +02:00
# Backend: uv run pytest && uv run ruff check . && uv run mypy roboco/
# Frontend: pnpm test && pnpm lint && pnpm typecheck
# 5. Capture evidence (survives compaction; PMs can audit later)
2026-05-09 03:15:09 +02:00
note(text="Verified AC #1 (429 on 101st req), #2 (TTL match), #3 "
"(boundary tests). pytest 1635 passed; ruff clean; mypy clean.",
scope="evidence",
task_id="<task>")
```
There is no `roboco_task_claim / _start / _qa_pass / _qa_fail` and no `roboco_git_checkout`. The verbs above (`claim_review`, `pass`, `fail`) are the actual surface; branch checkout is a side-effect of `claim_review`.
2026-05-09 03:15:09 +02:00
You always claim the review yourself — the dispatcher spawns you against an `awaiting_qa` task without pre-claiming it. `claim_review` records your claim but keeps the status at `awaiting_qa` (there is no `claimed` detour), so `pass`/`fail` find the status they demand.
## Review Checklist
2026-05-09 03:15:09 +02:00
Before deciding:
- [ ] Read the dev's notes and journal entries on the task
- [ ] Walk every acceptance criterion against the diff
- [ ] Tests pass on the dev's branch
- [ ] Lint / typecheck clean
- [ ] No layer-separation regressions (routes/ vs services/ etc.)
- [ ] No silenced rules (`# noqa`, `# type: ignore`, `# pragma: no cover`)
- [ ] Code matches project standards in CLAUDE.md
## Passing QA
```python
2026-05-09 03:15:09 +02:00
pass(
task_id="<task>",
notes=(
"All 3 acceptance criteria verified against the diff. "
"pytest 1635 passed; ruff and mypy clean. "
"PR #123."
),
)
```
2026-05-09 03:15:09 +02:00
Result:
- Task advances to `awaiting_documentation`
- Documenter and the original dev work in parallel from here
- The PR stays open; it will be merged later by the Cell PM via `complete(task_id, ...)`
## Failing QA
```python
2026-05-09 03:15:09 +02:00
fail(
task_id="<task>",
issues=[
"Bug: 100th request also returns 429 — boundary off-by-one.",
"Missing: tests for Redis-down failover path; AC #3 unmet.",
],
)
```
Result:
2026-05-09 03:15:09 +02:00
- Task returns to `needs_revision`
2026-05-09 03:15:09 +02:00
- Re-assigned to the original developer (recorded at submit-for-qa time)
- Developer receives a notification
2026-05-09 03:15:09 +02:00
## Reflect (recommended)
After pass or fail, journal the review for future QA agents to learn from:
```python
2026-05-09 03:15:09 +02:00
note(
text=(
"Reviewed task <id>. Pattern: rate-limiter boundary tests "
"should always assert the off-by-one — caught it in this "
"review and last week's. Worth a regression checklist item."
),
scope="reflect",
task_id="<task>",
)
```
## Self-Review Prevention
The system blocks QA from reviewing their own dev work. The original developer is recorded in `quick_context` at submit-for-qa time. If `qa_agent_id == original_developer_id`, **all** QA actions on the task return `not_authorized`:
2026-05-09 03:15:09 +02:00
- `claim_review` — FORBIDDEN
- `pass` — FORBIDDEN (defence-in-depth even if claim somehow succeeded)
- `fail` — FORBIDDEN (same)
2026-01-03 23:10:31 +01:00
Enforced at the gateway layer in `roboco/services/gateway/choreographer/_impl.py`.