Skip to content

feat(framework): add review checklist consumed by the reviewer agent #253

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.

Sign up for GitHub

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
alexsoyes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(framework): add review checklist consumed by the reviewer agent #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions aidd_docs/review-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Review Checklist

Recurring defects the reviewer ticks on every code/diff review, so they get caught in any diff.

- [ ] **No information duplication** — DRY across code *and* docs; link to the canonical home instead of copying.
- [ ] **No incoherence / contradiction** — naming, behavior, and docs-vs-code stay consistent.
- [ ] **No over-engineering** — the simplest solution that meets the need; no speculative generality, no unused abstraction.
- [ ] **No dead code or debug leftovers** — no commented-out blocks, stray logs, or TODOs left silently.
- [ ] **Consistent with existing patterns** — follows the conventions already established in the codebase.
- [ ] **Clear, explicit naming** — names reveal intent; no misleading or vague identifiers.
- [ ] **Errors handled** — no swallowed exceptions, no ignored failure paths.
1 change: 1 addition & 0 deletions plugins/aidd-context/CATALOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Auto-generated index of skills, agents, references and assets shipped by the `ai
| `assets` | [golden-principles.md](skills/02-project-init/assets/golden-principles.md) | - |
| `assets` | [GUIDELINES.md](skills/02-project-init/assets/GUIDELINES.md) | - |
| `assets` | [README.md](skills/02-project-init/assets/README.md) | - |
| `assets` | [review-checklist.md](skills/02-project-init/assets/review-checklist.md) | - |
| `evals` | [scenarios.json](skills/02-project-init/evals/scenarios.json) | - |
| `-` | [README.md](skills/02-project-init/README.md) | - |
| `references` | [mapping-ai-context-file.md](skills/02-project-init/references/mapping-ai-context-file.md) | - |
Expand Down
1 change: 1 addition & 0 deletions plugins/aidd-context/skills/02-project-init/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ When this skill emits Mermaid diagrams, follow the project's Mermaid conventions
- `@assets/AGENTS.md` - canonical AI context file template
- `@assets/README.md` - `aidd_docs/README.md` template
- `@assets/GUIDELINES.md` - `aidd_docs/GUIDELINES.md` template
- `@assets/review-checklist.md` - `aidd_docs/review-checklist.md` template (baseline rules the reviewer agent applies on code reviews)
- `@assets/templates/memory/` - memory file templates (scope: `all` | `frontend` | `backend`)

## References
Expand Down
10 changes: 6 additions & 4 deletions plugins/aidd-context/skills/02-project-init/actions/02-scaffold-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ aidd_docs/
README.md
GUIDELINES.md
CONTRIBUTING.md
review-checklist.md
memory/
internal/.gitkeep
external/.gitkeep
Expand All @@ -23,10 +24,11 @@ aidd_docs/
1. If `aidd_docs/README.md` is absent -> write from `@../assets/README.md`. If present -> update it but take care to preserve any user customizations.
2. If `aidd_docs/GUIDELINES.md` is absent -> write from `@../assets/GUIDELINES.md`. If present -> update it but take care to preserve any user customizations.
3. If `aidd_docs/CONTRIBUTING.md` is absent -> write from `@../assets/CONTRIBUTING.md`. If present -> update it but take care to preserve any user customizations.
4. If `aidd_docs/memory/internal/` is absent -> create it. Always ensure `aidd_docs/memory/internal/.gitkeep` exists.
5. If `aidd_docs/memory/external/` is absent -> create it. Always ensure `aidd_docs/memory/external/.gitkeep` exists.
6. Print a summary table: `path | action taken (created | updated | skipped)`.
4. If `aidd_docs/review-checklist.md` is absent -> write from `@../assets/review-checklist.md`. If present -> preserve any user customizations.
5. If `aidd_docs/memory/internal/` is absent -> create it. Always ensure `aidd_docs/memory/internal/.gitkeep` exists.
6. If `aidd_docs/memory/external/` is absent -> create it. Always ensure `aidd_docs/memory/external/.gitkeep` exists.
7. Print a summary table: `path | action taken (created | updated | skipped)`.

## Test

`test -f aidd_docs/README.md && test -f aidd_docs/GUIDELINES.md && test -f aidd_docs/CONTRIBUTING.md && test -f aidd_docs/memory/internal/.gitkeep && test -f aidd_docs/memory/external/.gitkeep && echo ok` prints `ok`.
`test -f aidd_docs/README.md && test -f aidd_docs/GUIDELINES.md && test -f aidd_docs/CONTRIBUTING.md && test -f aidd_docs/review-checklist.md && test -f aidd_docs/memory/internal/.gitkeep && test -f aidd_docs/memory/external/.gitkeep && echo ok` prints `ok`.
11 changes: 11 additions & 0 deletions plugins/aidd-context/skills/02-project-init/assets/review-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Review Checklist

@jdm-web jdm-web Jun 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ce fichier semble identique à ‎aidd_docs/review-checklist.md.
On a pas moyen d'en avoir qu'un seul?
S'il faut vraiment physiquement les deux on a pas moyen de scaffolder à partir d'une source plutôt que d'avoir 2 sources?

@blafourcade blafourcade Jun 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

En fait c'est le Skill actuel de Alex qui le met dans le aidd_docs justement ! @jdm-web


Recurring defects the reviewer ticks on every code/diff review, so they get caught in any diff.

- [ ] **No information duplication** — DRY across code *and* docs; link to the canonical home instead of copying.
- [ ] **No incoherence / contradiction** — naming, behavior, and docs-vs-code stay consistent.
- [ ] **No over-engineering** — the simplest solution that meets the need; no speculative generality, no unused abstraction.
- [ ] **No dead code or debug leftovers** — no commented-out blocks, stray logs, or TODOs left silently.
- [ ] **Consistent with existing patterns** — follows the conventions already established in the codebase.
- [ ] **Clear, explicit naming** — names reveal intent; no misleading or vague identifiers.
- [ ] **Errors handled** — no swallowed exceptions, no ignored failure paths.
2 changes: 2 additions & 0 deletions plugins/aidd-dev/agents/reviewer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ When invoked, you receive:
- A **validator** - either explicit acceptance criteria (e.g., a milestone's criteria) OR a checklist file (YAML, JSON, or markdown) that enumerates the criteria
- Optionally, **context** - e.g., the spec when reviewing a plan, or the plan when reviewing code

On every review, read the project review checklist at `aidd_docs/review-checklist.md` (path relative to the repository root, your working directory) with your Read tool, and apply each item; skip silently if the file is absent. Render the checklist ticked in your output — `- [x]` when met, `- [ ]` with the offending `file:line` when not.

# Outputs

When you return, your output is structured:
Expand Down