-
Notifications
You must be signed in to change notification settings - Fork 4
task-observer: new docs/ai/review from 2026-07-20 #76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
divad12
wants to merge
1
commit into
master
Choose a base branch
from
task-observer/review-2026-07-20
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| > **IMPORTANT: Before reading, check if you already read this file earlier in this session. If yes, skip the read and announce "Context already loaded: review.md (re-using from earlier)". If no, read it and announce "Context loaded: review.md".** | ||
|
|
||
| # Review Contracts | ||
|
|
||
| ## Contract | ||
|
|
||
| - Orchestration skills (`/deep-review`, `/fly` gates) say how to run the workflow. This doc holds the reusable contracts for what to look for and how to route findings. | ||
| - Global review contracts belong here. Project-specific review lenses belong in `<project>/docs/ai/review.md` as a delta that links here and adds only project-specific constraints. | ||
| - Do not restate a global contract in a project doc; add the project-specific override and point here for the rest. | ||
|
|
||
| ## Scope | ||
|
|
||
| Determine the correct review base before starting: | ||
|
|
||
| - Read `PROGRESS.md`, `AGENTS.md`, or equivalent to find the declared integration branch (`main`, `master`, `m3`, etc.). | ||
| - Use that branch as the review base. Do not default to `main` without checking. | ||
| - State the base branch choice in the review summary so the reader can verify the scope. | ||
|
|
||
| ## Finding Admissibility | ||
|
|
||
| Before raising a finding, check whether the project has explicitly de-scoped the area: | ||
|
|
||
| - Read `AGENTS.md` for any "No X yet", "X is not needed", or "X is out of scope" declarations. | ||
| - If the area is de-scoped, the finding is inadmissible — do not raise it. | ||
| - Asymmetric calibration (enforcing violations but ignoring de-scoping) produces false positives. The inverse rule is equally mandatory: de-scoped features trump default-convention findings. | ||
|
|
||
| Projects that share this rule: no ARIA/screen reader work yet, no mobile/RTL, no i18n, single-user, desktop-only — any of these means the corresponding finding class is inadmissible until the de-scoping is lifted. | ||
|
|
||
| ## Bug-Fix Routing | ||
|
|
||
| After every deterministic bug fix, route the learning through `/learn`: | ||
|
|
||
| 1. **Fixed incident** — root cause, symptom, fix, and affected files. | ||
| 2. **Principle** — the violated contract at the highest actionable level. Climb until the principle helps future work find sibling bugs across the codebase, not just the one that just occurred. | ||
| 3. **Anti-pattern** — the thought pattern or shortcut that produced the bug. | ||
| 4. **Enforcement candidate** — at least one mechanical check that would prevent recurrence: a test, lint rule, schema scan, shared helper, or checklist item. | ||
|
|
||
| Bug-learning files form an abstraction ladder, not competing ledgers. If a project keeps both a fixed-incident log and a bug-patterns doc, keep them at different abstraction rungs (specific incident vs. reusable bug class) rather than duplicating the same content. | ||
|
|
||
| ## Notes | ||
|
|
||
| - Review scope must follow the project's declared integration branch. Wrong base produces a noisy diff that buries real findings in unrelated volume. | ||
| - Admissibility check is mandatory for any project with explicit de-scoping rules. Reviewers default to industry conventions (WCAG, mobile, i18n) unless the project's rules say otherwise. | ||
| - Enforcement candidates are not optional refinements — a bug class without one is only partially learned. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new global contract is not loaded by normal review workflows:
.claude/AGENTS.md's adaptive-docs table still routes only git/writing/ask-intern/learning, and the only existingreview.mdrouting I found is preflight's generated task pre-reading, while/deep-reviewstill hard-codesmainfor branch scope. As a result, repos whose integration branch ismaster/m3will still get the noisy or wrong review base this doc is meant to prevent unless the review skills or root routing table are updated to read it.Useful? React with 👍 / 👎.