@danieljvdm/dev-kit 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@danieljvdm/dev-kit",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "private": false,
5
5
  "description": "Agent-led TypeScript repository setup and curated portable skills.",
6
6
  "license": "MIT",
@@ -103,5 +103,13 @@
103
103
  ],
104
104
  "licensePath": "LICENSE",
105
105
  },
106
+ {
107
+ "id": "humanlayer-skills",
108
+ "repository": "https://github.com/humanlayer/skills.git",
109
+ "ref": "main",
110
+ "skillsPath": "plugins/show-me/skills",
111
+ "include": ["show-me"],
112
+ "licensePath": "LICENSE",
113
+ },
106
114
  ],
107
115
  }
@@ -295,6 +295,22 @@
295
295
  "sentry-snapshots-cocoa": "sha256:9eeee7bc649475f2d8c00cb2725edcf07d9a6ce2784b4fbaf24ba0bd6de8f44b"
296
296
  },
297
297
  "licensePath": "LICENSE"
298
+ },
299
+ {
300
+ "id": "humanlayer-skills",
301
+ "repository": "https://github.com/humanlayer/skills.git",
302
+ "ref": "main",
303
+ "resolved": "3c2629142c5d437428269b1b722b08c0b87f574d",
304
+ "skillsPath": "plugins/show-me/skills",
305
+ "include": ["show-me"],
306
+ "skills": ["show-me"],
307
+ "descriptions": {
308
+ "show-me": "Help the user understand the current topic visually with concise diagrams, code-shape sketches, and focused HTML artifacts."
309
+ },
310
+ "digests": {
311
+ "show-me": "sha256:be24b98422f4e577f95eff91b1a46c82b7b063356923c466c11f596a920ed51b"
312
+ },
313
+ "licensePath": "LICENSE"
298
314
  }
299
315
  ]
300
316
  }
@@ -1,122 +1,78 @@
1
1
  ---
2
2
  name: open-pull-request
3
- description: Open pull requests with conventional commits, reviewer-complete descriptions, links to vital code, and concrete evidence. Use whenever preparing or opening a pull request, including checking commit history, explaining a bug or architectural change, drafting the title or body, and attaching screenshots or other evidence.
3
+ description: Prepare, open, update, or land pull requests with brief summaries, architecture diagrams, API examples, and useful screenshots or videos.
4
4
  ---
5
5
 
6
- # Open a Pull Request
7
-
8
- Produce a PR that a reviewer can understand and trust without access to the
9
- task conversation.
10
-
11
- ## Prepare the branch
12
-
13
- 1. Read the repository's contribution instructions and PR template. Identify
14
- the intended base branch, then inspect the full commit range, diff, and
15
- working tree. Finish when the PR scope contains no accidental changes and
16
- the description will cover the branch as it exists, not merely the latest
17
- task.
18
- 2. Use Conventional Commits for every commit you create and for the PR title:
19
- `type(scope): imperative summary`. Follow repository-specific types and
20
- scopes, and omit the scope when it adds no useful context. Otherwise use a
21
- precise standard type such as `feat`, `fix`, `refactor`, `docs`, `test`,
22
- `build`, `ci`, or `chore`. Keep each commit to one logical concern. Rewrite
23
- only commits you created and know are unshared; get approval before
24
- rewriting user-authored or published history.
25
- 3. Run the repository's required validation on the final branch state, then
26
- collect the strongest available evidence of the changed behavior. Identify
27
- the few files, symbols, or modules a reviewer must understand and prepare
28
- links that resolve in the rendered PR. Finish when every claim can be traced
29
- to the diff, CI, or a verified artifact.
30
-
31
- ## Write for the reviewer
32
-
33
- Write clear, compact English for someone with little context. Give the reviewer
34
- enough explanation to agree with both the problem and the solution; do not
35
- sacrifice causal or architectural context for brevity. Lead with the observable
36
- outcome, then explain why the change was needed and how the important pieces
37
- fit together. Prefer concrete nouns and expand uncommon acronyms. Describe
38
- behavior and impact rather than narrating the task conversation.
39
-
40
- Link the vital implementation points from the summary or architecture section.
41
- Use descriptive link text that names each piece by its role, such as the request
42
- router or cache invalidation boundary, and verify every link after opening the
43
- PR. Link the core pieces a reviewer should inspect, not every touched file.
44
-
45
- For every bug fix, include a **What went wrong** section in plain English. State
46
- the incorrect behavior, its actual root cause and causal chain, and why the
47
- change fixes it. Make uncertainty or incomplete coverage explicit. A result
48
- such as "fixed stale state" is not a diagnosis; explain how the stale state was
49
- created or allowed to survive.
50
-
51
- When the change alters architecture, identify the affected components and
52
- boundaries, what each one owns after the change, and any important change to
53
- control flow, data flow, public contracts, or persistence. Link to the core
54
- implementation of each affected piece. Use a dedicated **Architecture** section
55
- when this would make the change easier to review; otherwise include the context
56
- in the summary.
57
-
58
- Use the repository's required template when present. Otherwise use this small
59
- shape and omit empty sections:
60
-
61
- ```md
62
- ## Summary
63
-
64
- - <What changes for a user, operator, or developer>
65
- - <Why it matters and the shape of the solution, with links to vital code>
66
-
67
- ## What went wrong
68
-
69
- <For a bug fix: explain the symptom, root cause, causal chain, and why this fix
70
- addresses it.>
71
-
72
- ## Architecture
73
-
74
- - <When applicable: explain the changed components, ownership, and flow, with
75
- links to their core implementations.>
76
-
77
- ## Evidence
78
-
79
- - <Screenshot, before/after output, request/response, trace, or other verified
80
- artifact>
6
+ # Pull requests
7
+
8
+ Give the reviewer a high-level account of what changed and why. Usually a
9
+ short paragraph or a few bullets is enough. Add a risk, limitation, or manual
10
+ deploy step only when it affects their decision. Skip code tours, investigation
11
+ history, routine CI recaps, and prescribed sections or accordions.
12
+
13
+ ## Explain architecture and APIs
14
+
15
+ Pick the smallest view that makes the change clear, and place it beside the
16
+ short explanation it supports. Prefer a diagram or example over a long prose
17
+ description; simple changes can stay prose-only.
18
+
19
+ - For changes to component ownership, boundaries, or data flow, include a
20
+ focused Mermaid architecture chart. Use a sequence diagram when call order
21
+ matters. Name the actual components, label the interactions, and make the
22
+ changed responsibility or path clear without mapping the whole system.
23
+ - For new or changed APIs, show a concrete caller example: an HTTP request and
24
+ response, or a typed function/SDK call and its result. Include the inputs,
25
+ outputs, and error behavior relevant to the change. Use a small before/after
26
+ diff when callers must migrate; show the complete example when the API is new.
27
+
28
+ Use fenced Mermaid and code blocks directly in the PR. A call tree or pseudocode
29
+ can replace a chart when it explains the change more clearly. Match diagrams
30
+ and examples to the final implementation, use safe fixture data, and distinguish
31
+ illustrative or expected output from output actually observed during validation.
32
+ Include both a chart and an API example when they answer different review
33
+ questions, not just to fill sections.
34
+
35
+ ## Capture visible behavior
36
+
37
+ For UI or visible features, capture the final running implementation during
38
+ verification and reuse it for the PR. A screenshot is the default; use a short
39
+ video when the sequence matters, such as an agent exchange or animation. Both
40
+ are rarely needed. Nonvisual changes need no screenshots or recordings.
41
+
42
+ Use existing capture tools; load `playwright-cli` for browser capture. Keep
43
+ recordings focused, usually under 30 seconds, without changing product timing.
44
+ Use safe fixture data and review the image or whole clip once for correctness
45
+ and private content. Treat published assets as public; unreviewed media stays
46
+ local. If inspection is unavailable, use a safe alternative or report the
47
+ blocker. Do not build viewers, extract frame galleries, or reconstruct GitHub.
48
+
49
+ Publish reviewed media with:
50
+
51
+ ```sh
52
+ vp run publish-pr-asset -- <file> <label> --caption "What this shows"
81
53
  ```
82
54
 
83
- Keep the body proportional to the change: a small change may need two useful
84
- bullets, while a subtle bug or architectural change may need several paragraphs.
85
- Omit conditional sections that do not apply. Make the title specific enough to
86
- stand alone in release notes and conventional enough to become the squash
87
- commit without editing.
88
-
89
- ## Show useful evidence
90
-
91
- Evidence is something the reviewer can inspect, not an assertion that the
92
- change works.
93
-
94
- - For a runnable UI or visual feature, capture and attach a screenshot or short
95
- recording of the actual final state. Use a representative viewport, add a
96
- short caption, and check the artifact for secrets or personal data.
97
- - For CLI, API, or automation behavior, include concise terminal output, a
98
- request/response example, generated artifact, or execution log when it proves
99
- the behavior more clearly than the CI result alone.
100
- - For a bug fix or behavior change, prefer before/after evidence when it is
101
- practical and materially clarifies the result.
102
- - For internal-only changes, include focused regression output, a trace, a
103
- generated artifact, or another result that demonstrates the changed behavior
104
- when available.
105
-
106
- Routine validation commands that CI always runs, such as `vp check` or standard
107
- format, lint, typecheck, and test commands, add no useful context to the PR body.
108
- Let CI report them. Mention a command or CI result only when it is unusual,
109
- cannot run in CI, or its output itself helps the reviewer understand the change.
110
-
111
- Include only evidence that was actually produced and verified. When expected
112
- visual proof cannot be produced, state the concrete reason briefly instead of
113
- silently substituting a claim. Choose the smallest set of evidence that makes
114
- the changed behavior easy to inspect. Omit the section when no evidence adds
115
- information beyond routine CI.
116
-
117
- ## Open and verify
118
-
119
- Open the PR against the intended base with the conventional title and prepared
120
- body. Then read back the rendered PR and verify the base/head branches, title,
121
- description, links, screenshots, and check results. Finish only when the PR is
122
- reviewable as rendered and return its URL.
55
+ Use the returned Markdown in the PR. Keep originals until publication succeeds;
56
+ if it fails, report the exact local path. Never extract browser cookies, expose
57
+ credentials in arguments, create asset branches, or invent an upload service.
58
+
59
+ ## Open or update the PR
60
+
61
+ For an already verified change, aim to publish within two minutes:
62
+
63
+ 1. Check the base, branch diff, and working tree for accidental changes. Reuse
64
+ review, validation, and evidence already completed for unchanged inputs;
65
+ `AGENTS.md` owns required checks.
66
+ 2. Use Conventional Commits for commits and the title. Commit and push the
67
+ intended changes, preserving unrelated work and published history.
68
+ 3. Open or update the PR with the short body, useful diagrams or API examples,
69
+ and existing evidence. With `gh`, use `--body-file` for multiline text.
70
+ 4. Read back base/head, title, and body once with `gh pr view`, then return the
71
+ URL. No GitHub browser inspection or wait for CI is required to open it.
72
+
73
+ Follow `AGENTS.md` for merge approval and required checks; opening a PR does
74
+ not authorize merging it.
75
+
76
+ When an existing draft PR is the subject, interpret "open it" or "ready it"
77
+ as making it ready for review unless the user asks to view it. State the intended
78
+ transition before acting; use `gh pr ready` rather than opening a browser.
@@ -1,4 +1,4 @@
1
1
  interface:
2
- display_name: "Open Pull Request"
3
- short_description: "Open clear, evidence-backed pull requests"
4
- default_prompt: "Use $open-pull-request to prepare and open a clear pull request with conventional commits and proof of work."
2
+ display_name: "Pull Requests"
3
+ short_description: "Explain PRs with architecture diagrams and API examples"
4
+ default_prompt: "Use $open-pull-request to prepare this PR with a brief summary, architecture diagrams or API examples where useful, and visual evidence for UI changes."