agentleFS
marnickvdamarnickvda/know-it-all/skills/design-review/SKILL.md

design-review

Skill3 starsChanged 10 days agoMITView on GitHub

Use after quiz-me on a pull request, or when the user wants to comment on a PR's design decisions and rollout risks one comment at a time. Design-level, not code-level: tradeoffs, failure modes, third-party defaults, docs that disagree with behavior, rollout and rollback. Triggers include "design review on PR #123", "turn the quiz into review comments", "comment on the design of this PR with me".

155 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use project-stage-detect, team-audio and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • CoralGameSkill

    project-stage-detect

    Automatically analyze project state, detect stage, identify gaps, and recommend next steps based on existing artifacts.

    Also in 16 projects that use this

  • CoralGameSkill

    team-audio

    Orchestrate audio team: audio-director + sound-designer + technical-artist + gameplay-programmer for full audio pipeline from direction to implementation.

    Also in 13 projects that use this

  • julianoczkowskiSkill

    brief-to-tasks

    Break a design brief into an ordered checklist of independently buildable tasks using vertical slices. Saves as a markdown checklist. Use when user wants to break down work, create tasks from a brief, plan implementation order, or mentions "tasks" or "breakdown".

    Also in 7 projects that use this

  • lilangMaxSkill

    asset-spec

    Generate per-asset visual specifications and AI generation prompts from GDDs, level docs, or character profiles. Produces structured spec files and updates the master asset manifest. Run after art bible and GDD/level design are approved, before production begins.

    Also in 10 projects that use this

  • lilangMaxSkill

    create-control-manifest

    After architecture is complete, produces a flat actionable rules sheet for programmers — what you must do, what you must never do, per system and per layer. Extracted from all Accepted ADRs, technical preferences, and engine reference docs. More immediately actionable than ADRs (which explain why).

    Also in 10 projects that use this

  • +4 more from CoralGame
  • +3 more from lilangMax

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 128 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run inside a local clone of the PR's repo.

    line 16
  2. Distinctive:

    Already covered?: If the PR description or an existing comment already states the point, drop it or narrow it to what is new.

    line 31
  3. Distinctive:

    After that, each comment gets its own message, in exactly this shape:

    line 43
  4. Distinctive:

    After the last comment, list the approved comments, each review type's drafted summary body (PR-wide comments go in it), then offer a short …

    line 74
  5. Distinctive:

    Clean up: if a handoff file was used, offer to delete it.

    line 88

“Common” is measured: kept by at least 6 in 10 of the 128 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Design Review

Walk the user through design-level review comments on a PR, one comment per message, then post the approved ones as one GitHub review. The user approves every word; nothing goes to GitHub before they pick the review type.

Short choices end the message as a numbered plain-text list, after the content; then stop. The user replies with a number or in their own words. Every message here carries content above its choice, so it all stays in the message text: a question-tool popup can hide the text before it.

In scope: design decisions, rollout and rollback risks, failure modes, third-party defaults the code relies on, docs or comments that disagree with real behavior. Out of scope: code-level bugs, style, tests, naming. A code-level bug is a comment only when it makes behavior contradict the docs or PR description; then frame it as a question about that mismatch, not a fix. Otherwise mention it to the user in one line and move on.

1. Gather

Run inside a local clone of the PR's repo. No number given: gh pr view --json number finds the PR of the current branch. Get the quiz results, richest first:

  • This conversation — quiz-me on this PR just ran: use its answer key, grades, gaps, parked questions.
  • Handoff file — <git common dir>/quiz-me/pr-<n>.md (git rev-parse --path-format=absolute --git-common-dir). Compare its ## PR head SHA with gh pr view <n> --json headRefOid. If they differ, stop: tell the user both SHAs and ask whether to use the notes anyway, re-check them, or ignore them. Wait for the answer.
  • Neither — build the answer key yourself (step 2), without quizzing the user.

Then read the PR: gh pr view <n> (description), gh pr view <n> --comments (existing review comments), gh pr diff <n>, and the full changed files at the head (git fetch origin pull/<n>/head, git show <sha>:<path>).

2. Checked claims only

Every claim a comment rests on must be checked against its source before you draft it: library defaults at the pinned version (read the source in the module cache or at that tag; options left unset are those defaults), chart values, API specs, the full files around the diff. Your memory is not a source. Quote the value and where you read it (e.g. "HTTP client v2.3.1 client.go: retries 3"). A handoff line tagged [unchecked] counts as unchecked. Can't check it? Drop the claim, or turn the comment into a question.

3. Find candidates

Sources: quiz gaps and parked questions that are real questions for the author; design or rollout risks found while checking; docs, comments or the PR description that disagree with behavior. Always ask: how is this switched off or rolled back if it misbehaves in production? If neither the PR nor its config answers that, it is a PR-wide candidate.

  • Already covered? If the PR description or an existing comment already states the point, drop it or narrow it to what is new. Tell the user which, and quote the line that covers it.
  • Anchor each comment on a changed line (right side of the diff); GitHub rejects others. A point about the PR as a whole (rollback, rollout plan, missing kill switch) or about unchanged code is PR-wide: it goes in the review body, never inline.

4. Overview, then one comment at a time

First message, all in one: one line on what you checked (sources), any dropped or narrowed points with why, then the overview table, then comment 1.

#WhereTopic
1queue/worker.go:52Docs say at-most-once; code retries
2PR-wideNo way to switch the new cache off without a deploy

After that, each comment gets its own message, in exactly this shape:

**Comment 2 of 4 · cache/cache.go:41 · rollout risk**

```diff
@@ -30,6 +38,9 @@ func New(cfg Config) *Cache {
 	c := &Cache{ttl: cfg.TTL}
+	c.client = redis.NewClient(&redis.Options{Addr: cfg.Addr})   ◀ comment here
 	return c
```

<1–2 sentences: why this matters.>

1. **Drafted:** > <the full comment>
2. **Shorter:** > <one sentence>
3. **Different angle or place:** > <e.g. a question instead, or move to the review body>

Then offer a short choice: Drafted, Shorter, Different angle, Skip. The user can also write their own.

Copy the hunk header and context lines from gh pr diff. Mark the commented line(s). For a range, mark each line. PR-wide comments: header says PR-wide, no diff block, and say it goes in the review body. Then stop and wait.

Pushback ("isn't this overengineering?", "do you agree?"): give your honest view in a few sentences and a clear recommendation. Recommend skip when the comment doesn't earn its place; hold your ground when it does. Neither cave nor insist by reflex.

5. Comment style

Short, plain language, one point per comment. Prefix nits with nit:. Mark non-blocking points (non-blocking). Unsure? Ask a question, don't state an opinion as fact.

6. Review type, post, verify

After the last comment, list the approved comments, each review type's drafted summary body (PR-wide comments go in it), then offer a short choice: Comment, Approve, or Request changes. Post nothing until the user picks.

Then post one review. Build the payload in a file (a script or a heredoc into a .json file), never inline shell quoting:

{"commit_id": "<head SHA>", "event": "COMMENT", "body": "<summary + PR-wide comments>",
 "comments": [{"path": "queue/worker.go", "line": 52, "side": "RIGHT", "body": "..."},
              {"path": "cache/cache.go", "start_line": 39, "start_side": "RIGHT", "line": 41, "side": "RIGHT", "body": "..."}]}

gh api repos/<owner>/<repo>/pulls/<n>/reviews --method POST --input review.json. event is COMMENT, APPROVE or REQUEST_CHANGES.

Verify: gh api repos/<owner>/<repo>/pulls/<n>/comments --paginate --jq '.[] | select(.pull_request_review_id == <review id>) | "\(.path):\(.line)"' (the per-review comments endpoint returns line: null; don't use it). Report a table: intended path:line vs posted path:line, ✓ or ✗, then the review URL. Fix any ✗ with the user.

Clean up: if a handoff file was used, offer to delete it. Delete the payload file.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.