From 09fc3e5a26aea6e29ee417bc6dd381a0c19cd0e6 Mon Sep 17 00:00:00 2001 From: Agents Date: Sun, 6 Sep 2026 10:24:20 +0100 Subject: [PATCH] docs(agent): add show-me review guidance --- .agents/DEFINITION_OF_DONE.md | 3 + .claude/skills/show-me/LICENSE | 21 +++++ .claude/skills/show-me/NATIVEPROOF.md | 10 ++ .claude/skills/show-me/PROVENANCE.md | 11 +++ .claude/skills/show-me/SKILL.md | 127 ++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 6 ++ AGENTS.md | 5 +- CLAUDE.md | 3 + skills-lock.json | 11 +++ 9 files changed, 196 insertions(+), 1 deletion(-) create mode 100644 .claude/skills/show-me/LICENSE create mode 100644 .claude/skills/show-me/NATIVEPROOF.md create mode 100644 .claude/skills/show-me/PROVENANCE.md create mode 100644 .claude/skills/show-me/SKILL.md create mode 100644 skills-lock.json diff --git a/.agents/DEFINITION_OF_DONE.md b/.agents/DEFINITION_OF_DONE.md index ba76663..155aa5e 100644 --- a/.agents/DEFINITION_OF_DONE.md +++ b/.agents/DEFINITION_OF_DONE.md @@ -24,6 +24,9 @@ A NativeProof change is done only when the local proof matches the claim. - Include exact commands run and whether they passed. - Include generated-project or device proof when the change affects those paths. - Do not mark a PR ready while GitHub checks are queued or running. +- For a non-trivial PR, include the smallest source-verified view that removes + review ambiguity. A view explains evidence. It never replaces tests, + screenshots, reports, source links, warnings, or uncertainty. ## Inline PR Proof Law diff --git a/.claude/skills/show-me/LICENSE b/.claude/skills/show-me/LICENSE new file mode 100644 index 0000000..f7ad6f4 --- /dev/null +++ b/.claude/skills/show-me/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 HumanLayer + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/.claude/skills/show-me/NATIVEPROOF.md b/.claude/skills/show-me/NATIVEPROOF.md new file mode 100644 index 0000000..2f7d859 --- /dev/null +++ b/.claude/skills/show-me/NATIVEPROOF.md @@ -0,0 +1,10 @@ +# NativeProof show-me guidance + +Read this file with `SKILL.md`. These repository rules override the upstream HTML instruction. + +- Use a view for a substantive pull request when it removes review ambiguity. Do not add a visual to a trivial pull request. +- Choose the smallest useful view, such as a focused diff, call tree, file tree, pseudocode, or Mermaid diagram. +- Verify every label, path, symbol, relationship, and sequence against the current source. Put source paths or symbols beside the view when they help a reviewer check it. +- A view explains evidence. It never replaces tests, screenshots, reports, source links, warnings, or explicit uncertainty. +- Use HTML only when a text view or Mermaid cannot make the point clearly and HTML is permitted for the task. Write it under `.e2e-artifacts/show-me//` so it stays local and ignored. +- Do not automatically open, publish, or commit HTML. Do not run the upstream `open` command unless the user explicitly asks to open the artifact. diff --git a/.claude/skills/show-me/PROVENANCE.md b/.claude/skills/show-me/PROVENANCE.md new file mode 100644 index 0000000..0b0dfc3 --- /dev/null +++ b/.claude/skills/show-me/PROVENANCE.md @@ -0,0 +1,11 @@ +# Upstream provenance + +- Repository: https://github.com/humanlayer/skills +- Commit: `3c2629142c5d437428269b1b722b08c0b87f574d` +- Source: `plugins/show-me/skills/show-me/SKILL.md` +- Pinned source: https://github.com/humanlayer/skills/blob/3c2629142c5d437428269b1b722b08c0b87f574d/plugins/show-me/skills/show-me/SKILL.md +- Installed: 2026-09-04 +- Install command: `npx -y skills add humanlayer/skills --skill show-me --agent claude-code --copy -y` +- Upstream `SKILL.md` SHA-256: `bea6da70a58096730b9aeb0bae293ddf4726103a98efc9ce13c481619942a810` + +`SKILL.md` is an unmodified copy from the pinned commit. Repository-specific rules live in `NATIVEPROOF.md`. diff --git a/.claude/skills/show-me/SKILL.md b/.claude/skills/show-me/SKILL.md new file mode 100644 index 0000000..d57a0a0 --- /dev/null +++ b/.claude/skills/show-me/SKILL.md @@ -0,0 +1,127 @@ +--- +name: show-me +description: Help the user understand the current topic visually with concise diagrams, code-shape sketches, and focused HTML artifacts. +--- + +Help the user understand the current topic of conversation visually. Skip the preamble and keep prose brief. Pick the smallest view that makes the key point clear. + +- Show logic or an algorithm as pseudocode: + +```text +on(save) + if content is unchanged + return cached result + write new content + return fresh result +``` + +- Show runtime control flow as a call tree: + +```text +submitForm + createSession + persistPrompt + launchAgent + navigateToSession +``` + +- Show UI structure as a component tree, including state and module boundaries that matter: + +```tsx + (apps/example/src/routes/session.tsx) + useSessionEvents() + + (packages/ui) +``` + +- Show file responsibility or a broad refactor as a shallow file tree: + +```text +src/ +├── commands/ # parses user actions +├── sessions/ # owns session state +└── transport/ # sends API requests +``` + +- Show component interaction, control flow, or data flow with Mermaid: + +```mermaid +sequenceDiagram + participant User + participant UI + participant Daemon + User->>UI: choose command + UI->>Daemon: send expanded prompt + Daemon-->>UI: stream result +``` + +- Use `diff` when the point is what changes and the surrounding shape already exists. Match the diff shape to the topic. + +For a component change: + +```diff + + useSessionEvents() + ++ + ++ +``` + +For a file-layout change: + +```diff + src/ + ├── commands/ ++│ └── show-me.ts # expands the slash command + ├── sessions/ +-└── transport.ts ++└── transport/ ++ ├── client.ts ++ └── stream.ts +``` + +For a call-tree or call-stack change: + +```diff + submitForm + createSession + persistPrompt ++ expandSkillMention + launchAgent +- navigateToSession ++ navigateToSession ++ subscribeToEvents +``` + +For a state or control-flow change: + +```diff + on(save) +- write content ++ if content is unchanged ++ return cached result ++ write new content ++ invalidate cache +``` + +- Show the whole block when most of it is new, when omitted context would hide ownership or order, or when the user needs a copyable target shape: + +```ts +function expandSkill(command: string): string { + const skillName = command.slice(1) + return `use the ${skillName} skill` +} +``` + +- For a visual UI, layout, state comparison, or concept too dense for Mermaid, write one focused HTML file — a diagram, an infographic, or a short slide deck, whichever fits the point. Match the product's colors, type, spacing, and components; use real labels and data; support desktop and mobile. Then open it for the user: + +``` +Bash(open path/to/show-me-{description}.html) +``` + +### guidance + +Place each visual next to the short text it supports. Keep only the calls, files, props, states, and boundaries needed to answer the user's current question or the options to resolve the current discussion point. + +You may use one of these, you may use several, it is unlikely you will use all of them. Use your judgement and don't overwhelm the user. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c70ed2b..6f67da7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,6 +8,12 @@ - [ ] `npm test` - [ ] Generated project/device proof, or N/A: +## Reviewer view + +- Smallest source-verified view for a non-trivial PR, or `Not applicable` with + the reason for a trivial PR: +- Source files, symbols, states, or commands that verify the view: + ## Risk - diff --git a/AGENTS.md b/AGENTS.md index aa561cf..5f317af 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -17,7 +17,10 @@ stdlib or native platform features before adding abstractions or dependencies. Before opening, updating, or marking a PR ready, read `.agents/DEFINITION_OF_DONE.md` and -`.agents/skills/pr-inline-screenshot-proof/SKILL.md`. +`.agents/skills/pr-inline-screenshot-proof/SKILL.md`. For a non-trivial PR, +also read `.claude/skills/show-me/NATIVEPROOF.md` with the upstream show-me +skill and choose the smallest source-verified view that removes review +ambiguity. - Screenshot proof must be committed to the branch and embedded inline in the PR body with `![alt](...png?raw=1)`. diff --git a/CLAUDE.md b/CLAUDE.md index 3ca1e9e..a77a0b6 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -21,6 +21,9 @@ Read the matching skill in `.agents/skills/` before these tasks: - `device-lane-proof` — device/Appium behaviour changes and on-device screenshot proof. - `release-changelog` — version bumps, CHANGELOG entries, cutting a release. - `pr-inline-screenshot-proof` — embedding proof inline in any PR body. +- `show-me` — for a non-trivial PR, read + `.claude/skills/show-me/NATIVEPROOF.md` with the upstream skill and choose the + smallest source-verified view that removes review ambiguity. ## PR Proof Law diff --git a/skills-lock.json b/skills-lock.json new file mode 100644 index 0000000..53b25b7 --- /dev/null +++ b/skills-lock.json @@ -0,0 +1,11 @@ +{ + "version": 1, + "skills": { + "show-me": { + "source": "humanlayer/skills", + "sourceType": "github", + "skillPath": "plugins/show-me/skills/show-me/SKILL.md", + "computedHash": "de32a72f802801f08a84641b467f2c6306d35a58ce5e59ea607ac3a993a18c91" + } + } +}