@event4u/agent-config 1.16.0 → 1.18.0

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.
Files changed (224) hide show
  1. package/.agent-src/commands/{agents-audit.md → agents/audit.md} +4 -3
  2. package/.agent-src/commands/{agents-cleanup.md → agents/cleanup.md} +12 -6
  3. package/.agent-src/commands/{agents-prepare.md → agents/prepare.md} +4 -3
  4. package/.agent-src/commands/agents.md +46 -0
  5. package/.agent-src/commands/{chat-history-checkpoint.md → chat-history/checkpoint.md} +4 -4
  6. package/.agent-src/commands/{chat-history-clear.md → chat-history/clear.md} +4 -4
  7. package/.agent-src/commands/{chat-history-resume.md → chat-history/resume.md} +4 -4
  8. package/.agent-src/commands/chat-history/show.md +107 -0
  9. package/.agent-src/commands/chat-history.md +33 -89
  10. package/.agent-src/commands/{commit-in-chunks.md → commit/in-chunks.md} +15 -13
  11. package/.agent-src/commands/commit.md +22 -2
  12. package/.agent-src/commands/{context-create.md → context/create.md} +4 -3
  13. package/.agent-src/commands/{context-refactor.md → context/refactor.md} +4 -3
  14. package/.agent-src/commands/context.md +44 -0
  15. package/.agent-src/commands/{copilot-agents-init.md → copilot-agents/init.md} +4 -3
  16. package/.agent-src/commands/{copilot-agents-optimize.md → copilot-agents/optimize.md} +4 -3
  17. package/.agent-src/commands/copilot-agents.md +44 -0
  18. package/.agent-src/commands/council/default.md +221 -0
  19. package/.agent-src/commands/{council-design.md → council/design.md} +6 -5
  20. package/.agent-src/commands/{council-optimize.md → council/optimize.md} +7 -6
  21. package/.agent-src/commands/{council-pr.md → council/pr.md} +6 -5
  22. package/.agent-src/commands/council.md +47 -212
  23. package/.agent-src/commands/{create-pr-description.md → create-pr/description-only.md} +4 -2
  24. package/.agent-src/commands/create-pr.md +26 -5
  25. package/.agent-src/commands/{feature-dev.md → feature/dev.md} +5 -10
  26. package/.agent-src/commands/{feature-explore.md → feature/explore.md} +4 -8
  27. package/.agent-src/commands/{feature-plan.md → feature/plan.md} +4 -8
  28. package/.agent-src/commands/{feature-refactor.md → feature/refactor.md} +4 -8
  29. package/.agent-src/commands/{feature-roadmap.md → feature/roadmap.md} +6 -10
  30. package/.agent-src/commands/feature.md +6 -12
  31. package/.agent-src/commands/{fix-ci.md → fix/ci.md} +4 -8
  32. package/.agent-src/commands/{fix-portability.md → fix/portability.md} +4 -8
  33. package/.agent-src/commands/{fix-pr-bot-comments.md → fix/pr-bots.md} +4 -8
  34. package/.agent-src/commands/{fix-pr-developer-comments.md → fix/pr-developers.md} +4 -8
  35. package/.agent-src/commands/{fix-pr-comments.md → fix/pr.md} +7 -11
  36. package/.agent-src/commands/{fix-references.md → fix/refs.md} +4 -8
  37. package/.agent-src/commands/{fix-seeder.md → fix/seeder.md} +4 -8
  38. package/.agent-src/commands/fix.md +7 -13
  39. package/.agent-src/commands/{do-and-judge.md → judge/on-diff.md} +4 -3
  40. package/.agent-src/commands/judge/solo.md +90 -0
  41. package/.agent-src/commands/{do-in-steps.md → judge/steps.md} +4 -3
  42. package/.agent-src/commands/judge.md +35 -70
  43. package/.agent-src/commands/{memory-add.md → memory/add.md} +4 -3
  44. package/.agent-src/commands/{memory-full.md → memory/load.md} +4 -3
  45. package/.agent-src/commands/{memory-promote.md → memory/promote.md} +4 -3
  46. package/.agent-src/commands/{propose-memory.md → memory/propose.md} +4 -3
  47. package/.agent-src/commands/memory.md +48 -0
  48. package/.agent-src/commands/{module-create.md → module/create.md} +4 -3
  49. package/.agent-src/commands/{module-explore.md → module/explore.md} +4 -3
  50. package/.agent-src/commands/module.md +44 -0
  51. package/.agent-src/commands/{optimize-agents.md → optimize/agents.md} +4 -8
  52. package/.agent-src/commands/{optimize-augmentignore.md → optimize/augmentignore.md} +4 -9
  53. package/.agent-src/commands/{optimize-rtk-filters.md → optimize/rtk.md} +4 -8
  54. package/.agent-src/commands/{optimize-skills.md → optimize/skills.md} +4 -8
  55. package/.agent-src/commands/optimize.md +4 -10
  56. package/.agent-src/commands/{override-create.md → override/create.md} +4 -3
  57. package/.agent-src/commands/{override-manage.md → override/manage.md} +4 -3
  58. package/.agent-src/commands/override.md +44 -0
  59. package/.agent-src/commands/{roadmap-create.md → roadmap/create.md} +4 -3
  60. package/.agent-src/commands/{roadmap-execute.md → roadmap/execute.md} +4 -3
  61. package/.agent-src/commands/roadmap.md +44 -0
  62. package/.agent-src/commands/{tests-create.md → tests/create.md} +4 -3
  63. package/.agent-src/commands/{tests-execute.md → tests/execute.md} +4 -3
  64. package/.agent-src/commands/tests.md +44 -0
  65. package/.agent-src/contexts/communication/rules-auto/artifact-engagement-recording-mechanics.md +72 -0
  66. package/.agent-src/contexts/communication/rules-auto/augment-portability-mechanics.md +79 -0
  67. package/.agent-src/contexts/communication/rules-auto/augment-source-of-truth-mechanics.md +98 -0
  68. package/.agent-src/contexts/communication/rules-auto/cli-output-handling-mechanics.md +87 -0
  69. package/.agent-src/contexts/communication/rules-auto/command-suggestion-policy-mechanics.md +62 -0
  70. package/.agent-src/contexts/communication/rules-auto/docs-sync-mechanics.md +78 -0
  71. package/.agent-src/contexts/communication/rules-auto/package-ci-checks-mechanics.md +85 -0
  72. package/.agent-src/contexts/communication/rules-auto/review-routing-awareness-mechanics.md +65 -0
  73. package/.agent-src/contexts/communication/rules-auto/roadmap-progress-sync-mechanics.md +78 -0
  74. package/.agent-src/contexts/communication/rules-auto/skill-quality-mechanics.md +62 -0
  75. package/.agent-src/contexts/communication/rules-auto/slash-command-routing-policy-mechanics.md +55 -0
  76. package/.agent-src/contexts/communication/rules-auto/ui-audit-gate-mechanics.md +53 -0
  77. package/.agent-src/contexts/communication/rules-auto/user-interaction-mechanics.md +77 -0
  78. package/.agent-src/contexts/judges/no-consolidate-rationale.md +102 -0
  79. package/.agent-src/contexts/judges/persona-voice-rubric.md +140 -0
  80. package/.agent-src/rules/artifact-engagement-recording.md +13 -69
  81. package/.agent-src/rules/ask-when-uncertain.md +27 -42
  82. package/.agent-src/rules/augment-portability.md +15 -61
  83. package/.agent-src/rules/augment-source-of-truth.md +27 -93
  84. package/.agent-src/rules/cli-output-handling.md +10 -76
  85. package/.agent-src/rules/command-suggestion-policy.md +18 -59
  86. package/.agent-src/rules/commit-conventions.md +17 -14
  87. package/.agent-src/rules/context-hygiene.md +6 -0
  88. package/.agent-src/rules/direct-answers.md +35 -59
  89. package/.agent-src/rules/docker-commands.md +5 -5
  90. package/.agent-src/rules/docs-sync.md +15 -69
  91. package/.agent-src/rules/language-and-tone.md +48 -72
  92. package/.agent-src/rules/missing-tool-handling.md +28 -22
  93. package/.agent-src/rules/no-cheap-questions.md +39 -53
  94. package/.agent-src/rules/no-roadmap-references.md +73 -0
  95. package/.agent-src/rules/onboarding-gate.md +7 -0
  96. package/.agent-src/rules/package-ci-checks.md +21 -61
  97. package/.agent-src/rules/preservation-guard.md +64 -29
  98. package/.agent-src/rules/review-routing-awareness.md +24 -43
  99. package/.agent-src/rules/roadmap-progress-sync.md +31 -65
  100. package/.agent-src/rules/rule-type-governance.md +28 -0
  101. package/.agent-src/rules/security-sensitive-stop.md +8 -8
  102. package/.agent-src/rules/skill-quality.md +16 -48
  103. package/.agent-src/rules/slash-command-routing-policy.md +7 -4
  104. package/.agent-src/rules/think-before-action.md +52 -42
  105. package/.agent-src/rules/tool-safety.md +19 -16
  106. package/.agent-src/rules/ui-audit-gate.md +24 -38
  107. package/.agent-src/rules/user-interaction.md +13 -68
  108. package/.agent-src/skills/ai-council/SKILL.md +2 -0
  109. package/.agent-src/skills/api-testing/SKILL.md +1 -1
  110. package/.agent-src/skills/check-refs/SKILL.md +59 -40
  111. package/.agent-src/skills/conventional-commits-writing/SKILL.md +86 -28
  112. package/.agent-src/skills/copilot-agents-optimization/SKILL.md +5 -5
  113. package/.agent-src/skills/developer-like-execution/SKILL.md +4 -4
  114. package/.agent-src/skills/finishing-a-development-branch/SKILL.md +101 -65
  115. package/.agent-src/skills/flux/SKILL.md +30 -10
  116. package/.agent-src/skills/github-ci/SKILL.md +2 -2
  117. package/.agent-src/skills/judge-code-quality/SKILL.md +7 -8
  118. package/.agent-src/skills/judge-security-auditor/SKILL.md +4 -5
  119. package/.agent-src/skills/judge-test-coverage/SKILL.md +3 -4
  120. package/.agent-src/skills/lint-skills/SKILL.md +57 -39
  121. package/.agent-src/skills/md-language-check/SKILL.md +61 -39
  122. package/.agent-src/skills/override-management/SKILL.md +5 -5
  123. package/.agent-src/skills/quality-tools/SKILL.md +2 -2
  124. package/.agent-src/skills/react-shadcn-ui/SKILL.md +116 -43
  125. package/.agent-src/skills/readme-reviewer/SKILL.md +30 -29
  126. package/.agent-src/skills/readme-writing/SKILL.md +78 -53
  127. package/.agent-src/skills/readme-writing-package/SKILL.md +50 -47
  128. package/.agent-src/skills/receiving-code-review/SKILL.md +52 -47
  129. package/.agent-src/skills/refine-prompt/SKILL.md +0 -1
  130. package/.agent-src/skills/requesting-code-review/SKILL.md +35 -30
  131. package/.agent-src/skills/security/SKILL.md +7 -2
  132. package/.agent-src/skills/security-audit/SKILL.md +7 -3
  133. package/.agent-src/skills/systematic-debugging/SKILL.md +68 -60
  134. package/.agent-src/skills/test-driven-development/SKILL.md +59 -57
  135. package/.agent-src/skills/test-performance/SKILL.md +0 -1
  136. package/.agent-src/skills/traefik/SKILL.md +4 -4
  137. package/.agent-src/skills/verify-completion-evidence/SKILL.md +28 -26
  138. package/.agent-src/templates/roadmaps.md +4 -0
  139. package/.claude-plugin/marketplace.json +22 -11
  140. package/AGENTS.md +2 -2
  141. package/CHANGELOG.md +125 -1
  142. package/README.md +18 -17
  143. package/docs/architecture.md +4 -6
  144. package/docs/catalog.md +67 -39
  145. package/docs/contracts/STABILITY.md +13 -7
  146. package/docs/contracts/adr-chat-history-split.md +1 -3
  147. package/docs/contracts/adr-command-suggestion.md +0 -2
  148. package/docs/contracts/adr-implement-ticket-runtime.md +1 -2
  149. package/docs/contracts/adr-product-ui-track.md +3 -6
  150. package/docs/contracts/adr-prompt-driven-execution.md +3 -4
  151. package/docs/contracts/agent-memory-contract.md +6 -11
  152. package/docs/contracts/artifact-engagement-flow.md +6 -9
  153. package/docs/contracts/command-clusters.md +56 -46
  154. package/docs/contracts/command-suggestion-flow.md +1 -3
  155. package/docs/contracts/context-paths.md +99 -0
  156. package/docs/contracts/file-ownership-matrix.json +6722 -0
  157. package/docs/contracts/file-ownership-matrix.md +134 -0
  158. package/docs/contracts/implement-ticket-flow.md +6 -9
  159. package/docs/contracts/linear-ai-rules-inclusion.md +0 -1
  160. package/docs/contracts/linear-ai-three-layers.md +0 -2
  161. package/docs/contracts/load-context-budget-model.md +258 -0
  162. package/docs/contracts/load-context-schema.md +21 -3
  163. package/docs/contracts/roadmap-complexity-standard.md +137 -0
  164. package/docs/contracts/rule-interactions.md +0 -1
  165. package/docs/contracts/rule-priority-hierarchy.md +1 -1
  166. package/docs/contracts/ui-track-flow.md +7 -17
  167. package/docs/customization.md +2 -0
  168. package/docs/getting-started.md +5 -4
  169. package/docs/guidelines/agent-infra/ask-when-uncertain-demos.md +134 -0
  170. package/docs/guidelines/agent-infra/asking-and-brevity-examples.md +100 -0
  171. package/docs/guidelines/agent-infra/direct-answers-demos.md +145 -0
  172. package/docs/guidelines/agent-infra/verify-before-complete-demos.md +128 -0
  173. package/package.json +1 -1
  174. package/scripts/_phase2_shim_helper.py +109 -0
  175. package/scripts/agent-config +30 -0
  176. package/scripts/ai_council/one_off_archive/2026-05/README.md +45 -0
  177. package/scripts/ai_council/one_off_archive/2026-05/_one_off_2a4_acceptance.py +208 -0
  178. package/scripts/ai_council/one_off_archive/2026-05/_one_off_budget_v2_audit.py +206 -0
  179. package/scripts/ai_council/one_off_archive/2026-05/_one_off_context_layer_v1_estimate.py +67 -0
  180. package/scripts/ai_council/one_off_archive/2026-05/_one_off_context_layer_v1_review.py +292 -0
  181. package/scripts/ai_council/one_off_archive/2026-05/_one_off_followups_review.py +259 -0
  182. package/scripts/ai_council/one_off_archive/2026-05/_one_off_nondestructive_inline_audit.py +209 -0
  183. package/scripts/ai_council/one_off_archive/2026-05/_one_off_phase4_dispatch_latency.py +108 -0
  184. package/scripts/ai_council/one_off_archive/2026-05/_one_off_phase6_trigger_jaccard.py +92 -0
  185. package/scripts/ai_council/one_off_archive/2026-05/_one_off_phase_2a_budget_rebalance.py +257 -0
  186. package/scripts/ai_council/one_off_archive/2026-05/_one_off_phase_2a_post_revert.py +197 -0
  187. package/scripts/ai_council/one_off_archive/2026-05/_one_off_rule_hardening_v1.py +251 -0
  188. package/scripts/ai_council/one_off_archive/2026-05/_one_off_structural_open_questions.py +232 -0
  189. package/scripts/ai_council/one_off_archive/2026-05/_one_off_structural_optimization.py +144 -0
  190. package/scripts/ai_council/one_off_archive/2026-05/_one_off_structural_v3_gaps.py +252 -0
  191. package/scripts/ai_council/one_off_archive/2026-05/_one_off_structural_v3_review.py +240 -0
  192. package/scripts/build_rule_trigger_matrix.py +360 -0
  193. package/scripts/check_always_budget.py +402 -45
  194. package/scripts/check_cluster_patterns.py +159 -0
  195. package/scripts/check_command_count_messaging.py +14 -7
  196. package/scripts/check_context_paths.py +201 -0
  197. package/scripts/check_no_roadmap_refs.py +155 -0
  198. package/scripts/check_one_off_location.py +81 -0
  199. package/scripts/check_phase_coupling.py +148 -0
  200. package/scripts/check_portability.py +2 -0
  201. package/scripts/check_references.py +35 -2
  202. package/scripts/check_safety_floor_untouched.py +125 -0
  203. package/scripts/command_suggester/loader.py +4 -1
  204. package/scripts/compress.py +64 -15
  205. package/scripts/context_hygiene_hook.py +173 -0
  206. package/scripts/generate_index.py +6 -2
  207. package/scripts/generate_ownership_matrix.py +323 -0
  208. package/scripts/hooks/augment-context-hygiene.sh +55 -0
  209. package/scripts/hooks/augment-onboarding-gate.sh +55 -0
  210. package/scripts/hooks/augment-roadmap-progress.sh +57 -0
  211. package/scripts/install.py +105 -45
  212. package/scripts/lint_examples.py +98 -0
  213. package/scripts/lint_no_new_atomic_commands.py +12 -11
  214. package/scripts/lint_roadmap_complexity.py +127 -0
  215. package/scripts/onboarding_gate_hook.py +137 -0
  216. package/scripts/requirements-evals.txt +1 -0
  217. package/scripts/roadmap_progress_hook.py +159 -0
  218. package/scripts/schemas/command.schema.json +4 -3
  219. package/scripts/schemas/rule.schema.json +5 -0
  220. package/scripts/skill_linter.py +1 -0
  221. package/scripts/sync_agent_settings.py +25 -2
  222. package/scripts/update_counts.py +7 -0
  223. /package/scripts/ai_council/{_one_off_rebalancing_audit.py → one_off_archive/2026-05/_one_off_rebalancing_audit.py} +0 -0
  224. /package/scripts/ai_council/{_one_off_roundtrip.py → one_off_archive/2026-05/_one_off_roundtrip.py} +0 -0
@@ -15,29 +15,34 @@ execution:
15
15
  - Creating a new README for an **application, CLI tool, internal tool, template, or framework**
16
16
  - Rewriting an outdated or weak README
17
17
  - Improving after major repo changes (new tooling, restructure)
18
+ - Adapting README for a different audience
18
19
 
19
- Do NOT use for:
20
+ Do NOT use when:
20
21
 
21
- - **Packages/libraries** → use `readme-writing-package` instead
22
- - Minor typos, single-section updates, reference docs in separate files
22
+ - Writing a README for a **reusable package or library** → use `readme-writing-package` instead
23
+ - Fixing minor typos or updating a single section
24
+ - Writing reference docs that belong in separate files
25
+ - Only adding a badge or version bump
23
26
 
24
27
  ## Goal
25
28
 
26
- Accurate, evidence-based, scannable README for the intended audience.
27
- Reflects the real repository — not assumptions.
29
+ Write a README that is accurate, evidence-based, scannable, and useful for
30
+ the intended audience. Reflects the real repository — not assumptions.
28
31
 
29
32
  ## Core principles
30
33
 
31
- - Analyze first, write second — inspect repo before writing
32
- - Evidence-based — every command, step, feature must exist in repo
33
- - Strong quickstart over exhaustive noise — get started in 30 seconds
34
- - Right scope — overview in README, deep content in dedicated docs
35
- - Match repo type — package README app CLI tool framework
34
+ - **Analyze first, write second** — inspect the repo before writing a single line
35
+ - **Evidence-based only** — every command, setup step, and feature must exist in the repo
36
+ - **Strong quickstart over exhaustive noise**a reader should get started in 30 seconds
37
+ - **Right scope**high-level overview in README, deep content in dedicated docs
38
+ - **Match the repo type**a package README differs from an app, CLI tool, or framework
36
39
 
37
40
  ## Procedure
38
41
 
39
42
  ### 1. Identify README type and audience
40
43
 
44
+ Determine repository type:
45
+
41
46
  | Type | Audience | Priority |
42
47
  |---|---|---|
43
48
  | **Library/Package** | Developers consuming it | Install → Usage → API |
@@ -49,94 +54,114 @@ Reflects the real repository — not assumptions.
49
54
 
50
55
  ### 2. Inspect the repository
51
56
 
52
- Read truth-defining files:
57
+ Read these files to extract truth:
53
58
 
54
- - `README.md` (existing), `package.json`, `composer.json`
55
- - `Dockerfile`, `docker-compose.yml`
56
- - `Taskfile.yml`, `Makefile`
57
- - CI workflows, config files, `docs/`, `agents/`
59
+ - `README.md` (existing, if any)
60
+ - `package.json`, `composer.json` — name, description, scripts, dependencies
61
+ - `Dockerfile`, `docker-compose.yml` — runtime setup
62
+ - `Taskfile.yml`, `Makefile` available commands
63
+ - CI workflows — what gets tested, how
64
+ - `docs/`, `agents/` — existing documentation
65
+ - Config files — what tools are used
58
66
 
59
- Extract: purpose, install path, commands, requirements, workflows, testing, contribution flow.
67
+ Extract: project purpose, install path, main commands, requirements,
68
+ key workflows, testing/linting commands, contribution flow.
60
69
 
61
70
  ### 3. Choose sections
62
71
 
63
- Only include sections that provide value:
72
+ Only include sections that provide value. Candidates:
64
73
 
65
74
  1. **Title + one-line summary** — always
66
- 2. **Why / what problem** — if not obvious from name
67
- 3. **Key features** — if more than trivial
75
+ 2. **Why / what problem it solves** — if not obvious from name
76
+ 3. **Key features or capabilities** — if more than a trivial tool
68
77
  4. **Requirements** — only if non-obvious
69
78
  5. **Installation / setup** — always
70
- 6. **Usage / quickstart** — always (most important)
71
- 7. **Configuration** — if applicable
72
- 8. **Development workflow** — if accepts contributions
79
+ 6. **Usage / quickstart** — always (most important section)
80
+ 7. **Configuration / customization** — if applicable
81
+ 8. **Development workflow** — if repo accepts contributions
73
82
  9. **Testing / quality** — if tooling exists
74
83
  10. **Project structure** — if non-trivial
75
- 11. **Contributing** — if open/team project
84
+ 11. **Contributing** — if open or team project
76
85
  12. **License** — if applicable
77
86
 
87
+ Do NOT include sections "because READMEs usually have them."
78
88
  Skip empty or near-empty sections entirely.
79
89
 
80
90
  ### 4. Write evidence-based content
81
91
 
82
- - Only document commands that exist in the repo
92
+ Rules:
93
+
94
+ - Only document commands that actually exist in the repo
83
95
  - Only describe setup steps supported by scripts/configs
84
96
  - Only claim features confirmed by code or docs
85
- - Unclear? Inspect more or ask — never invent
97
+ - If something is unclear: inspect more or ask — never invent
98
+
99
+ Formatting:
86
100
 
87
- Formatting: tables for comparisons, code blocks for commands (copy-pasteable),
88
- short paragraphs (max 3 sentences), directory trees for structure.
101
+ - Tables for structured comparisons (tools, options, features)
102
+ - Code blocks for every command (copy-pasteable)
103
+ - Short paragraphs — max 3 sentences before a break
104
+ - Directory trees for project structure (use `tree` format)
105
+ - Badges only if they link to live CI/release status
89
106
 
90
- ### 5. Optimize for first screen
107
+ ### 5. Optimize for the first screen
91
108
 
92
- Reader must answer within 10 seconds: What is this? Why? How to start?
109
+ A reader scanning the README should answer within 10 seconds:
93
110
 
94
- First screen (before scroll): title, summary, install or quickstart.
111
+ 1. What is this?
112
+ 2. Why does it exist?
113
+ 3. How do I install/start it?
114
+
115
+ The first screen (before scrolling) must contain the title, summary,
116
+ and either install command or quickstart. Everything else comes after.
95
117
 
96
118
  ### 6. Size and structure
97
119
 
98
- Keep README scannable. Past ~150 lines: add Table of Contents. Past ~300
99
- lines: split deep content to `/docs/` or `references/`. Use `<details>`
100
- only for secondary, bulky content never for install, first example, or
101
- requirements.
120
+ Keep the README scannable. If it grows past ~150 lines, add a Table of
121
+ Contents; past ~300 lines, split deep content out to `/docs/` or
122
+ `references/`. Use `<details>` only for secondary, bulky content (never
123
+ for install, first example, or requirements).
102
124
 
103
125
  → See `docs/guidelines/docs/readme-size-and-splitting.md` for thresholds,
104
126
  splitting strategies (reference-split, deep-link tables, collapsibles),
105
- multi-audience handling, anti-patterns.
127
+ multi-audience handling, and anti-patterns.
106
128
 
107
129
  ### 7. Validate
108
130
 
109
- - [ ] Every command exists in repo (`Taskfile.yml`, `Makefile`, `package.json`, etc.)
110
- - [ ] Setup steps are reproducible
111
- - [ ] No invented features or capabilities
131
+ After writing, verify:
132
+
133
+ - [ ] Every documented command exists in the repo (`Taskfile.yml`, `Makefile`, `package.json scripts`, etc.)
134
+ - [ ] Setup steps are reproducible (no missing prerequisites)
135
+ - [ ] No features or capabilities are invented
112
136
  - [ ] First screen answers: what, why, how-to-start
113
137
  - [ ] No dead sections (heading with 1-2 trivial sentences)
114
- - [ ] Deep content in dedicated docs, not crammed in README
115
- - [ ] Size below "overloaded" threshold, or splitting in place (see size guideline)
116
- - [ ] ToC present if > 150 lines or > 6 top-level sections
138
+ - [ ] Scope is right — deep content moved to dedicated docs, not crammed in
139
+ - [ ] Size below the "overloaded" threshold, or splitting is in place (see size guideline)
140
+ - [ ] ToC present if README > 150 lines or > 6 top-level sections
141
+ - [ ] Matches existing tonality if repo has established voice
117
142
  - [ ] All file paths and references are valid
118
143
 
119
144
  ## Output format
120
145
 
121
146
  1. Full README draft
122
147
  2. Short note: detected repo type + audience
123
- 3. Uncertainties or assumptions needing confirmation
148
+ 3. Any uncertainties or assumptions that need confirmation
124
149
 
125
150
  ## Gotcha
126
151
 
127
- - Model writes generic boilerplate instead of repo-specific docs
128
- - Model includes commands/steps that don't exist in the repo
129
- - Model over-documents, burying the quickstart under walls of text
130
- - Existing README structure can mislead — don't preserve weak structure blindly
131
- - Package READMEs need install/usage focus, not internal dev workflow
132
- - Model forgets to validate commands against `Taskfile.yml` / `Makefile` / `package.json`
152
+ - The model tends to write generic boilerplate instead of repo-specific documentation
153
+ - The model tends to include commands or setup steps that don't actually exist in the repo
154
+ - The model tends to over-document and bury the quickstart under walls of text
155
+ - Existing README structure can be misleading — don't preserve weak structure blindly
156
+ - READMEs for packages consumed by others need install/usage focus, not internal dev workflow
157
+ - The model forgets to validate commands against `Taskfile.yml` / `Makefile` / `package.json scripts`
133
158
 
134
159
  ## Do NOT
135
160
 
136
- - Do NOT invent features, setup steps, or commands not in the repo
137
- - Do NOT copy generic templates without adapting to the project
138
- - Do NOT overload with deep reference material — link to docs
161
+ - Do NOT invent features, setup steps, or commands not found in the repo
162
+ - Do NOT copy generic README templates without adapting to the actual project
163
+ - Do NOT overload with deep reference material — link to docs instead
139
164
  - Do NOT write for "everyone" — choose a real audience
140
165
  - Do NOT skip repository inspection before writing
141
- - Do NOT preserve weak structure just because it exists
142
- - Do NOT add marketing language ("blazing fast", "revolutionary")
166
+ - Do NOT preserve weak structure from an existing README just because it exists
167
+ - Do NOT add marketing language ("blazing fast", "revolutionary", "next-gen")
@@ -13,27 +13,28 @@ execution:
13
13
  ## When to use
14
14
 
15
15
  - Creating a README for a package, library, SDK, or framework extension
16
- - Rewriting after major changes (new API, version bump, new registry)
17
- - Improving a weak package README (missing install, no example, no compatibility)
18
- - Documenting for Packagist, npm, or internal registries
16
+ - Rewriting a package README after major changes (new API, version bump, new registry)
17
+ - Improving a weak package README (missing install, no example, no compatibility info)
18
+ - Documenting a package for Packagist, npm, or internal registries
19
19
 
20
- Do NOT use for:
20
+ Do NOT use when:
21
21
 
22
- - Full applications, CLI tools, internal team repos → use `readme-writing`
23
- - Minor typos, single-section updates, deep reference docs in `/docs`
22
+ - Documenting a full application, CLI tool, or internal team repo → use `readme-writing` instead
23
+ - Only fixing minor typos or updating a single section
24
+ - Writing deep reference docs that belong in `/docs`
24
25
 
25
26
  ## Goal
26
27
 
27
- Package README that makes adoption easy. Developer knows within 30 seconds:
28
- what it does, whether it fits their stack, how to install, how to use.
28
+ Package README that makes adoption easy. A developer should know within 30 seconds:
29
+ what it does, whether it fits their stack, how to install it, and how to use it.
29
30
 
30
31
  ## Core principles
31
32
 
32
- - User adoption over internal architecture — consumer first, maintainer second
33
- - Install + first example = most important sections
34
- - Compatibility must be explicit — don't imply broad support without evidence
35
- - First example: real, minimal, verified — no pseudo-code
36
- - README = onboarding, /docs = reference
33
+ - **User adoption over internal architecture** — consumer first, maintainer second
34
+ - **Install + first example = most important sections** — everything else is secondary
35
+ - **Compatibility must be explicit** — don't imply broad support without evidence
36
+ - **First code example must be real, minimal, and verified** — no pseudo-code
37
+ - **README = onboarding, /docs = reference** — keep README focused
37
38
 
38
39
  ## Procedure
39
40
 
@@ -49,16 +50,18 @@ what it does, whether it fits their stack, how to install, how to use.
49
50
 
50
51
  ### 2. Inspect package truth sources
51
52
 
53
+ Read files that define actual package behavior:
54
+
52
55
  - `composer.json` / `package.json` — name, description, requirements, scripts
53
- - Source entrypoints — public API, main classes/functions
56
+ - Source entrypoints — public API surface, main classes/functions
54
57
  - Config files — publishable configs, defaults
55
- - CI workflows — supported versions matrix
56
- - Tests — actual API usage patterns
58
+ - CI workflows — what gets tested, supported versions matrix
59
+ - Tests — reveal actual API usage patterns
57
60
  - `CHANGELOG.md` / releases — current state, breaking changes
58
- - Examples directory if present
61
+ - Examples directory if present
59
62
 
60
- Extract: name, purpose, install command, runtime requirements, supported
61
- versions, public API, setup steps, test/lint commands.
63
+ Extract: package name, purpose, install command, runtime requirements,
64
+ supported versions, public API, setup steps, test/lint commands.
62
65
 
63
66
  ### 3. Choose sections
64
67
 
@@ -68,14 +71,14 @@ Priority order for packages:
68
71
  2. **Why / what problem** — if not obvious from name
69
72
  3. **Requirements / compatibility** — always (versions, extensions, frameworks)
70
73
  4. **Installation** — always (exact command, post-install steps)
71
- 5. **Minimal usage example** — always (most important)
72
- 6. **Configuration** — if config publish, env vars, or registration needed
73
- 7. **More examples** — if API has multiple entry points
74
+ 5. **Minimal usage example** — always (most important section)
75
+ 6. **Configuration / setup** — if config publish, env vars, or registration needed
76
+ 7. **More examples / common use cases** — if API has multiple entry points
74
77
  8. **Development / testing** — for maintainers/contributors
75
- 9. **Contributing** — if open/team project
78
+ 9. **Contributing** — if open or team project
76
79
  10. **License** — if applicable
77
80
 
78
- Skip sections with no real content. Never pad.
81
+ Skip sections that have no real content. Never pad.
79
82
 
80
83
  ### 4. Write requirements and compatibility
81
84
 
@@ -89,12 +92,12 @@ State only what is tested and supported:
89
92
  - ext-json
90
93
  ```
91
94
 
92
- Don't imply broad compatibility if only tested in narrow range. Include
93
- framework version, language version, required extensions, services.
95
+ Do NOT imply broad compatibility if only tested in narrow range.
96
+ Include framework version, language version, required extensions, services.
94
97
 
95
98
  ### 5. Write installation that actually works
96
99
 
97
- Exact install command and required follow-up:
100
+ Document the exact install command and any required follow-up:
98
101
 
99
102
  ```bash
100
103
  composer require vendor/package
@@ -103,25 +106,25 @@ composer require vendor/package
103
106
  php artisan vendor:publish --tag=package-config
104
107
  ```
105
108
 
106
- Validate each step against the codebase. Include post-install steps
107
- (publish, register, env setup) if required.
109
+ Validate each step against the actual codebase.
110
+ Include post-install steps (publish, register, env setup) if required.
108
111
 
109
- ### 6. Write minimal working example
112
+ ### 6. Write the minimal working example
110
113
 
111
- **Most critical section.** Rules:
114
+ **This is the most critical section.** Rules:
112
115
 
113
116
  - Smallest possible working example — one use case, one result
114
117
  - Real API calls, not pseudo-code
115
118
  - Copy-pasteable without hidden setup
116
119
  - Show expected result or effect if helpful
117
- - Must match actual package API (verify against source)
120
+ - Must match the actual package API (verify against source)
118
121
 
119
122
  Bad: abstract, large, requires unexplained setup.
120
123
  Good: 5-15 lines, directly relevant, immediately runnable.
121
124
 
122
125
  ### 7. Keep architecture out of README — use reference-split
123
126
 
124
- Move deep content to dedicated docs. Recommended layout:
127
+ Move deep content to dedicated docs. Recommended layout for packages:
125
128
 
126
129
  ```
127
130
  README.md ← entry: what, why, install, minimal usage
@@ -133,13 +136,13 @@ docs/
133
136
  migration.md ← version upgrade guides
134
137
  ```
135
138
 
136
- Multi-platform install (> 5 variants): prefer single table with deep
137
- links over stacked inline blocks. Occasionally-needed detail (long
138
- platform quirks, troubleshooting): use `<details>` — never for install,
139
- first example, or requirements.
139
+ For multi-platform install (> 5 variants), prefer a single table with
140
+ deep links over stacked inline blocks. For occasionally-needed detail
141
+ (long platform quirks, troubleshooting), use `<details>` — never for
142
+ install, first example, or requirements.
140
143
 
141
144
  → See `docs/guidelines/docs/readme-size-and-splitting.md` for thresholds,
142
- deep-link-table pattern, collapsibles, anti-patterns (premature
145
+ deep-link-table pattern, collapsibles, and anti-patterns (premature
143
146
  splitting, duplication between README and `/docs/`).
144
147
 
145
148
  README = enough to adopt. Docs = enough to master.
@@ -148,11 +151,11 @@ README = enough to adopt. Docs = enough to master.
148
151
 
149
152
  - [ ] Install command is correct and complete
150
153
  - [ ] Compatibility/requirements match `composer.json` / `package.json` / CI matrix
151
- - [ ] First example matches real API (verified against source)
154
+ - [ ] First example matches real API (verified against source code)
152
155
  - [ ] All documented commands exist in repo
153
156
  - [ ] No invented features or capabilities
154
157
  - [ ] Consumer can get started without reading source code
155
- - [ ] Deep content in docs, not README (see size guideline)
158
+ - [ ] Deep content is in docs, not README (see size guideline)
156
159
  - [ ] Multi-platform install uses a table, not stacked blocks
157
160
  - [ ] No duplication between README and `/docs/`
158
161
  - [ ] First screen shows: what, install, requirements
@@ -167,11 +170,11 @@ README = enough to adopt. Docs = enough to master.
167
170
 
168
171
  ## Gotcha
169
172
 
170
- - Model writes package READMEs like app READMEs (too much architecture)
171
- - Model invents compatibility claims or setup steps
172
- - First example often too large, too abstract, or uses pseudo-code
173
+ - Model writes package READMEs like app READMEs (too much architecture, not enough install/usage)
174
+ - Model tends to invent compatibility claims or setup steps
175
+ - First example is often too large, too abstract, or uses pseudo-code
173
176
  - Model over-explains internals before showing how to use the package
174
- - Existing README may be outdated — verify against `composer.json` / source
177
+ - Existing README may be outdated — verify against actual `composer.json` / source, not old text
175
178
  - Model forgets post-install steps (config publish, service provider, env vars)
176
179
 
177
180
  ## Do NOT
@@ -179,7 +182,7 @@ README = enough to adopt. Docs = enough to master.
179
182
  - Do NOT invent package capabilities or compatibility
180
183
  - Do NOT skip the minimal working example
181
184
  - Do NOT prioritize internal architecture over user onboarding
182
- - Do NOT document commands not in the repo
185
+ - Do NOT document commands not present in the repo
183
186
  - Do NOT hide requirements or version constraints
184
- - Do NOT write a giant example when 10 lines would do
185
- - Do NOT overload README with reference material — link to /docs
187
+ - Do NOT write a giant example when a 10-line one would do
188
+ - Do NOT overload README with reference material — link to /docs
@@ -10,9 +10,10 @@ source: package
10
10
 
11
11
  ## When to use
12
12
 
13
- * PR has review comments (bots like Copilot, Greptile, Augment, or human
14
- reviewers) and the next step is addressing them
15
- * Someone pasted review feedback and asks you to "fix it" or "handle it"
13
+ * A PR has review comments (from bots like Copilot, Greptile, Augment,
14
+ or from human reviewers) and the next step is to address them
15
+ * Someone pasted review feedback into the conversation and asks you
16
+ to "fix it" or "handle it"
16
17
  * A pair-programming partner gave verbal suggestions about code you
17
18
  just wrote
18
19
  * You are tempted to reply "you are absolutely right" before reading
@@ -21,10 +22,10 @@ source: package
21
22
  Do NOT use when:
22
23
 
23
24
  * You are writing a review yourself (different discipline)
24
- * User explicitly asks for blind implementation of a specific change
25
- not framed as review feedback
26
- * Pure style/formatting the linter should decide automatically — run
27
- the linter
25
+ * The user explicitly asks for blind implementation of a specific change
26
+ that is not framed as review feedback
27
+ * The feedback is pure style/formatting that a linter should decide
28
+ automatically — just run the linter
28
29
 
29
30
  ## Goal
30
31
 
@@ -40,40 +41,42 @@ NO IMPLEMENTATION UNTIL THE FEEDBACK IS UNDERSTOOD AND VERIFIED.
40
41
  ```
41
42
 
42
43
  A "fix" implemented against a misread comment is worse than no fix —
43
- ships the wrong behavior under the label of "addressed feedback".
44
+ it ships the wrong behavior under the label of "addressed feedback".
44
45
 
45
46
  ## Procedure
46
47
 
47
48
  ### 1. Read the full comment set before touching code
48
49
 
49
50
  Read **every** open comment on the PR first. Comments often relate to
50
- each other — fixing comment #3 in isolation can conflict with #5. Group:
51
+ each other — fixing comment #3 in isolation can conflict with comment
52
+ #5. Group them:
51
53
 
52
54
  * **Blocking** — breaks behavior, introduces a bug, security issue
53
- * **Important** — logic correct but design / readability issue
55
+ * **Important** — logic is correct but design / readability issue
54
56
  * **Minor** — naming, comment style, formatting the linter missed
55
- * **Wrong** — reviewer misunderstood the code, or suggestion regresses
56
- another behavior
57
+ * **Wrong** — reviewer misunderstood the code, or suggestion would
58
+ regress another behavior
57
59
 
58
60
  ### 2. Restate each comment in your own words
59
61
 
60
62
  For every comment, write (internally or to the user): *"The reviewer
61
63
  is asking me to X because Y."*
62
64
 
63
- Cannot complete that sentence confidently → the comment is unclear. Ask
64
- for clarification **before** implementing anything. Do not implement
65
- the clear ones first and ask later — they may be linked.
65
+ If you cannot complete that sentence confidently → the comment is
66
+ unclear. Ask for clarification **before** implementing anything. Do
67
+ not implement the clear ones first and ask later — they may be linked.
66
68
 
67
69
  ### 3. Verify each claim against the code
68
70
 
69
- For each blocking/important comment:
71
+ For each comment classified as blocking/important:
70
72
 
71
73
  * Reproduce the alleged issue locally (run the test, hit the endpoint,
72
74
  read the actual runtime value — see [`systematic-debugging`](../systematic-debugging/SKILL.md))
73
75
  * Check what the code actually does, not what the reviewer **thinks**
74
76
  it does
75
77
  * Check whether the suggested fix would break another test or caller
76
- * Check `git blame` / history — current code may be that way for a reason
78
+ * Check `git blame` / history — the current code may be the way it is
79
+ for a reason
77
80
  * **Consult memory for prior context.** Via
78
81
  [`memory-access`](../../../docs/guidelines/agent-infra/memory-access.md),
79
82
  call `retrieve(types=["historical-patterns", "architecture-decisions"],
@@ -86,21 +89,21 @@ For each blocking/important comment:
86
89
 
87
90
  | Situation | Response |
88
91
  |---|---|
89
- | Reviewer right, fix local, no caller impact | Implement, reference the comment in the commit message |
90
- | Reviewer right but fix affects other callers | Note downstream effects in the reply, then implement |
91
- | Reviewer wrong — misreading the code | Reply with evidence (specific line / test / value), do not change code |
92
+ | Reviewer is right, fix is local, no caller impact | Implement, reference the comment in the commit message |
93
+ | Reviewer is right but fix affects other callers | Note the downstream effects in the reply, then implement |
94
+ | Reviewer is wrong — based on misreading the code | Reply with evidence (specific line / test / value), do not change code |
92
95
  | Reviewer suggests a feature the codebase does not use (YAGNI) | Reply asking whether the feature is actually needed, do not build speculatively |
93
96
  | Reviewer and user / architecture disagree | Escalate to the user before implementing either path |
94
97
 
95
98
  ### 5. Reply in the right place, with the right tone
96
99
 
97
- * Inline PR comments → reply **in the thread** of that comment, not as
98
- a top-level PR comment
100
+ * For inline PR comments → reply **in the thread** of that comment,
101
+ not as a top-level PR comment
99
102
  * Quote **evidence**, not opinion — "line 47 already handles this via
100
103
  `$x->isNull()`" beats "I think that's fine"
101
104
  * No flattery. No "great catch", "absolutely right", "thanks for
102
- noticing". The `language-and-tone` rule already bans this — actions
103
- are the acknowledgement
105
+ noticing". The existing `language-and-tone` rule already bans this —
106
+ actions are the acknowledgement
104
107
  * If you were wrong in your earlier pushback, state it factually and
105
108
  move on. No long apology
106
109
 
@@ -108,11 +111,11 @@ For each blocking/important comment:
108
111
 
109
112
  1. Blocking issues first
110
113
  2. Important issues next
111
- 3. Minor issues last (or bundle into a single commit)
114
+ 3. Minor issues last (or bundle them into a single commit)
112
115
  4. Wrong / YAGNI: no code change, only a reply with reasoning
113
116
 
114
- Run relevant tests and linters **between** each group — do not batch
115
- four changes and then run tests once. See
117
+ Run the relevant tests and linters **between** each group — do not
118
+ batch four changes and then run tests once. See
116
119
  [`verify-before-complete`](../verify-before-complete/SKILL.md).
117
120
 
118
121
  ## Output format
@@ -122,34 +125,36 @@ When reporting back to the user after handling review:
122
125
  1. **Triage table** — comment → classification → decision
123
126
  2. **Implemented changes** — bullet per change with file + commit ref
124
127
  3. **Pushed back** — bullet per rejected comment with the evidence
125
- 4. **Outstanding** — anything awaiting clarification, with the specific
126
- question
128
+ 4. **Outstanding** — anything awaiting clarification, with the
129
+ specific question
127
130
 
128
131
  ## Gotchas
129
132
 
130
133
  * Bot comments (Copilot, Greptile) are **not** automatically right.
131
- Frequently flag false positives on patterns the codebase uses
132
- deliberately. Verify like a human comment.
133
- * A comment reading like a question ("should this be X?") is often a
134
- polite way of saying "change it to X". Ask if unclear.
134
+ They frequently flag false positives on patterns the codebase uses
135
+ deliberately. Verify like you would a human comment.
136
+ * A comment that reads like a question ("should this be X?") is often
137
+ a polite way of saying "change it to X". Ask if unclear instead of
138
+ guessing the register.
135
139
  * Resolving a comment in the GitHub UI without an accompanying fix or
136
- reply silently marks it handled — reviewers may miss the lack of
137
- substance.
140
+ reply silently marks it handled — reviewers may not notice the lack
141
+ of substance.
138
142
  * Stacked PRs — a comment on the base PR may already be fixed in the
139
143
  child PR. Check both before touching code.
140
144
  * A suggestion that passes review aesthetics but fails the test suite
141
145
  is still a regression. Run tests even when "the change is trivial".
142
- * Flattery leaks in as "good point" or "thanks". Delete before sending.
146
+ * Flattery leaks in as "good point" or "thanks". Delete before
147
+ sending. The code change itself is the acknowledgement.
143
148
 
144
149
  ## Do NOT
145
150
 
146
151
  * Do NOT reply "you are absolutely right", "great catch", or any
147
152
  flattery variant — actions acknowledge, words do not
148
153
  * Do NOT implement a suggestion before verifying it against the code
149
- * Do NOT fix the clear items first and ask about the unclear ones later
150
- when the items are linked
151
- * Do NOT accept a reviewer's suggestion that conflicts with an explicit
152
- architectural decision without raising it
154
+ * Do NOT fix the clear items first and ask about the unclear ones
155
+ later when the items are linked
156
+ * Do NOT accept a reviewer's suggestion that conflicts with an
157
+ explicit architectural decision without raising it
153
158
  * Do NOT batch multiple unrelated fixes into one commit — reviewers
154
159
  cannot re-review selectively
155
160
  * Do NOT mark a comment resolved without either a code change or a
@@ -159,15 +164,15 @@ When reporting back to the user after handling review:
159
164
 
160
165
  * Replying "Fixed!" after a commit that does not actually address the
161
166
  comment (wrong file, missed case)
162
- * Rewriting the comment author's suggestion into your own words without
163
- checking whether the reinterpretation still matches intent
167
+ * Rewriting the comment author's suggestion into your own words
168
+ without checking whether the reinterpretation still matches intent
164
169
  * Implementing the YAGNI-suggested feature "just in case" the reviewer
165
170
  comes back
166
171
  * Silent disagreement — ignoring a comment without a reply
167
172
 
168
173
  ## When to hand over to another skill / command
169
174
 
170
- * Executing fixes across many comments → [`fix-pr-comments`](../../commands/fix-pr-comments.md)
175
+ * Executing the fixes across many comments → [`fix-pr-comments`](../../commands/fix-pr-comments.md)
171
176
  (handles both bot + developer), [`fix-pr-bot-comments`](../../commands/fix-pr-bot-comments.md),
172
177
  [`fix-pr-developer-comments`](../../commands/fix-pr-developer-comments.md)
173
178
  * Running the full verification gate before pushing replies →
@@ -181,10 +186,10 @@ When reporting back to the user after handling review:
181
186
 
182
187
  Before considering review handling done:
183
188
 
184
- * [ ] Every open comment read, classified, decision made
185
- * [ ] No comment implemented without a one-sentence restatement
186
- * [ ] Every implemented fix verified by a test or runtime check
189
+ * [ ] Every open comment has been read, classified, and has a decision
190
+ * [ ] No comment was implemented without a one-sentence restatement
191
+ * [ ] Every implemented fix has been verified by a test or runtime check
187
192
  * [ ] Every rejected comment has a reply quoting evidence
188
- * [ ] No comment marked resolved without code change or reply
193
+ * [ ] No comment was marked resolved without code change or reply
189
194
  * [ ] No reply contains flattery
190
195
  * [ ] Linters and relevant tests pass after the changes
@@ -217,4 +217,3 @@ For `low`, the question replaces the AC list:
217
217
  - [`work_engine.scoring.confidence`](../../templates/scripts/work_engine/scoring/confidence.py) — rubric + band thresholds
218
218
  - [`ask-when-uncertain`](../../rules/ask-when-uncertain.md) — one-question-per-turn Iron Law
219
219
  - [`artifact-drafting-protocol`](../../rules/artifact-drafting-protocol.md) — this skill was drafted under it
220
- - `agents/roadmaps/archive/road-to-prompt-driven-execution.md` — Phase 3 owns this skill (archived on completion)