tribunal-kit 4.5.0 → 4.6.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 (217) hide show
  1. package/.agent/.shared/ui-ux-pro-max/README.md +4 -4
  2. package/.agent/ARCHITECTURE.md +279 -277
  3. package/.agent/GEMINI.md +127 -121
  4. package/.agent/agents/accessibility-reviewer.md +187 -187
  5. package/.agent/agents/ai-code-reviewer.md +199 -199
  6. package/.agent/agents/api-architect.md +71 -66
  7. package/.agent/agents/backend-specialist.md +219 -215
  8. package/.agent/agents/cloud-engineer.md +98 -0
  9. package/.agent/agents/code-archaeologist.md +168 -161
  10. package/.agent/agents/database-architect.md +184 -184
  11. package/.agent/agents/db-latency-auditor.md +213 -216
  12. package/.agent/agents/debugger.md +198 -191
  13. package/.agent/agents/dependency-reviewer.md +106 -103
  14. package/.agent/agents/devops-engineer.md +218 -218
  15. package/.agent/agents/documentation-writer.md +209 -201
  16. package/.agent/agents/explorer-agent.md +167 -160
  17. package/.agent/agents/frontend-reviewer.md +162 -160
  18. package/.agent/agents/frontend-specialist.md +257 -248
  19. package/.agent/agents/game-developer.md +48 -48
  20. package/.agent/agents/logic-reviewer.md +118 -116
  21. package/.agent/agents/mobile-developer.md +197 -200
  22. package/.agent/agents/mobile-reviewer.md +159 -162
  23. package/.agent/agents/orchestrator.md +187 -181
  24. package/.agent/agents/penetration-tester.md +160 -157
  25. package/.agent/agents/performance-optimizer.md +183 -183
  26. package/.agent/agents/performance-reviewer.md +178 -178
  27. package/.agent/agents/precedence-reviewer.md +251 -250
  28. package/.agent/agents/product-manager.md +149 -142
  29. package/.agent/agents/product-owner.md +81 -80
  30. package/.agent/agents/project-planner.md +152 -142
  31. package/.agent/agents/qa-automation-engineer.md +216 -225
  32. package/.agent/agents/resilience-reviewer.md +88 -88
  33. package/.agent/agents/schema-reviewer.md +67 -67
  34. package/.agent/agents/security-auditor.md +180 -174
  35. package/.agent/agents/seo-specialist.md +188 -193
  36. package/.agent/agents/sql-reviewer.md +159 -161
  37. package/.agent/agents/supervisor-agent.md +173 -184
  38. package/.agent/agents/swarm-worker-contracts.md +170 -166
  39. package/.agent/agents/swarm-worker-registry.md +92 -92
  40. package/.agent/agents/system-architect.md +85 -0
  41. package/.agent/agents/test-coverage-reviewer.md +158 -160
  42. package/.agent/agents/test-engineer.md +118 -118
  43. package/.agent/agents/throughput-optimizer.md +291 -299
  44. package/.agent/agents/type-safety-reviewer.md +182 -175
  45. package/.agent/agents/ui-ux-auditor.md +300 -292
  46. package/.agent/agents/vitals-reviewer.md +223 -223
  47. package/.agent/mcp_config.json +37 -40
  48. package/.agent/patterns/generator.md +11 -9
  49. package/.agent/patterns/inversion.md +14 -12
  50. package/.agent/patterns/pipeline.md +11 -9
  51. package/.agent/patterns/reviewer.md +15 -13
  52. package/.agent/patterns/tool-wrapper.md +11 -9
  53. package/.agent/routing_index.json +654 -0
  54. package/.agent/rules/GEMINI.md +358 -352
  55. package/.agent/scripts/compile_router.py +112 -0
  56. package/.agent/scripts/migrate_skills_frontmatter.py +64 -0
  57. package/.agent/scripts/strengthen_skills.js +1 -1
  58. package/.agent/skills/advanced-rag-pipelines/SKILL.md +56 -0
  59. package/.agent/skills/agent-organizer/SKILL.md +156 -150
  60. package/.agent/skills/agentic-patterns/SKILL.md +313 -315
  61. package/.agent/skills/ai-prompt-injection-defense/SKILL.md +190 -184
  62. package/.agent/skills/api-patterns/SKILL.md +253 -247
  63. package/.agent/skills/api-security-auditor/SKILL.md +195 -193
  64. package/.agent/skills/app-builder/SKILL.md +573 -572
  65. package/.agent/skills/app-builder/templates/SKILL.md +108 -115
  66. package/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -76
  67. package/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -92
  68. package/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -88
  69. package/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -88
  70. package/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -83
  71. package/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -90
  72. package/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -90
  73. package/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +126 -122
  74. package/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +127 -122
  75. package/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +172 -169
  76. package/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +139 -134
  77. package/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -83
  78. package/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +122 -119
  79. package/.agent/skills/appflow-wireframe/SKILL.md +146 -145
  80. package/.agent/skills/architecture/SKILL.md +226 -219
  81. package/.agent/skills/authentication-best-practices/SKILL.md +197 -189
  82. package/.agent/skills/backend-security-expert/SKILL.md +16 -2
  83. package/.agent/skills/bash-linux/SKILL.md +179 -179
  84. package/.agent/skills/behavioral-modes/SKILL.md +239 -223
  85. package/.agent/skills/brainstorming/SKILL.md +498 -486
  86. package/.agent/skills/browser-native-ai/SKILL.md +57 -4
  87. package/.agent/skills/building-native-ui/SKILL.md +202 -202
  88. package/.agent/skills/cicd-pro/SKILL.md +442 -0
  89. package/.agent/skills/clean-code/SKILL.md +400 -381
  90. package/.agent/skills/cloud-architect/SKILL.md +439 -0
  91. package/.agent/skills/code-review-checklist/SKILL.md +203 -194
  92. package/.agent/skills/config-validator/SKILL.md +165 -165
  93. package/.agent/skills/containerization-pro/SKILL.md +452 -0
  94. package/.agent/skills/csharp-developer/SKILL.md +518 -518
  95. package/.agent/skills/data-validation-schemas/SKILL.md +333 -328
  96. package/.agent/skills/database-design/SKILL.md +247 -240
  97. package/.agent/skills/deployment-procedures/SKILL.md +172 -169
  98. package/.agent/skills/devops-engineer/SKILL.md +345 -345
  99. package/.agent/skills/devops-incident-responder/SKILL.md +143 -137
  100. package/.agent/skills/doc.md +209 -177
  101. package/.agent/skills/documentation-templates/SKILL.md +291 -279
  102. package/.agent/skills/edge-computing/SKILL.md +183 -181
  103. package/.agent/skills/error-resilience/SKILL.md +411 -428
  104. package/.agent/skills/extract-design-system/SKILL.md +160 -158
  105. package/.agent/skills/framer-motion-expert/SKILL.md +253 -244
  106. package/.agent/skills/frontend-design/SKILL.md +208 -201
  107. package/.agent/skills/frontend-security-expert/SKILL.md +16 -3
  108. package/.agent/skills/game-design-expert/SKILL.md +132 -129
  109. package/.agent/skills/game-engineering-expert/SKILL.md +148 -146
  110. package/.agent/skills/generative-ui-expert/SKILL.md +57 -1
  111. package/.agent/skills/geo-fundamentals/SKILL.md +148 -147
  112. package/.agent/skills/git-pro/SKILL.md +435 -0
  113. package/.agent/skills/github-operations/SKILL.md +335 -329
  114. package/.agent/skills/gsap-core/SKILL.md +319 -308
  115. package/.agent/skills/gsap-frameworks/SKILL.md +213 -207
  116. package/.agent/skills/gsap-performance/SKILL.md +139 -133
  117. package/.agent/skills/gsap-plugins/SKILL.md +486 -480
  118. package/.agent/skills/gsap-react/SKILL.md +202 -189
  119. package/.agent/skills/gsap-scrolltrigger/SKILL.md +357 -350
  120. package/.agent/skills/gsap-timeline/SKILL.md +165 -161
  121. package/.agent/skills/gsap-utils/SKILL.md +344 -338
  122. package/.agent/skills/harness-protocol/SKILL.md +48 -0
  123. package/.agent/skills/i18n-localization/SKILL.md +174 -163
  124. package/.agent/skills/intelligent-routing/SKILL.md +202 -246
  125. package/.agent/skills/knowledge-graph/SKILL.md +60 -52
  126. package/.agent/skills/lint-and-validate/SKILL.md +261 -261
  127. package/.agent/skills/llm-engineering/SKILL.md +400 -394
  128. package/.agent/skills/local-first/SKILL.md +178 -178
  129. package/.agent/skills/mcp-builder/SKILL.md +143 -142
  130. package/.agent/skills/mobile-design/SKILL.md +272 -263
  131. package/.agent/skills/monorepo-management/SKILL.md +335 -334
  132. package/.agent/skills/motion-engineering/SKILL.md +266 -234
  133. package/.agent/skills/nextjs-react-expert/SKILL.md +236 -234
  134. package/.agent/skills/nodejs-best-practices/SKILL.md +547 -548
  135. package/.agent/skills/observability/SKILL.md +343 -343
  136. package/.agent/skills/parallel-agents/SKILL.md +143 -146
  137. package/.agent/skills/performance-profiling/SKILL.md +259 -267
  138. package/.agent/skills/plan-writing/SKILL.md +150 -142
  139. package/.agent/skills/platform-engineer/SKILL.md +148 -147
  140. package/.agent/skills/playwright-best-practices/SKILL.md +188 -187
  141. package/.agent/skills/powershell-windows/SKILL.md +162 -162
  142. package/.agent/skills/project-idioms/SKILL.md +137 -137
  143. package/.agent/skills/python-patterns/SKILL.md +260 -259
  144. package/.agent/skills/python-pro/SKILL.md +324 -323
  145. package/.agent/skills/react-specialist/SKILL.md +305 -277
  146. package/.agent/skills/readme-builder/SKILL.md +310 -300
  147. package/.agent/skills/realtime-patterns/SKILL.md +323 -319
  148. package/.agent/skills/red-team-tactics/SKILL.md +231 -218
  149. package/.agent/skills/rust-pro/SKILL.md +671 -673
  150. package/.agent/skills/seo-fundamentals/SKILL.md +179 -179
  151. package/.agent/skills/server-management/SKILL.md +218 -214
  152. package/.agent/skills/shadcn-ui-expert/SKILL.md +231 -231
  153. package/.agent/skills/skill-creator/SKILL.md +87 -86
  154. package/.agent/skills/sql-pro/SKILL.md +629 -629
  155. package/.agent/skills/supabase-postgres-best-practices/SKILL.md +97 -97
  156. package/.agent/skills/swiftui-expert/SKILL.md +204 -201
  157. package/.agent/skills/system-design-pro/SKILL.md +345 -0
  158. package/.agent/skills/systematic-debugging/SKILL.md +153 -142
  159. package/.agent/skills/tailwind-patterns/SKILL.md +610 -566
  160. package/.agent/skills/tdd-workflow/SKILL.md +169 -161
  161. package/.agent/skills/test-result-analyzer/SKILL.md +313 -309
  162. package/.agent/skills/testing-patterns/SKILL.md +566 -579
  163. package/.agent/skills/trend-researcher/SKILL.md +243 -237
  164. package/.agent/skills/typescript-advanced/SKILL.md +336 -335
  165. package/.agent/skills/ui-ux-pro-max/SKILL.md +590 -562
  166. package/.agent/skills/ui-ux-researcher/SKILL.md +244 -244
  167. package/.agent/skills/vue-expert/SKILL.md +294 -275
  168. package/.agent/skills/vulnerability-scanner/SKILL.md +416 -404
  169. package/.agent/skills/web-accessibility-auditor/SKILL.md +219 -218
  170. package/.agent/skills/web-design-guidelines/SKILL.md +192 -186
  171. package/.agent/skills/webapp-testing/SKILL.md +167 -169
  172. package/.agent/skills/webgpu-performance/SKILL.md +56 -2
  173. package/.agent/skills/whimsy-injector/SKILL.md +346 -325
  174. package/.agent/skills/workflow-optimizer/SKILL.md +231 -229
  175. package/.agent/workflows/acf.md +141 -0
  176. package/.agent/workflows/api-tester.md +176 -151
  177. package/.agent/workflows/audit.md +150 -127
  178. package/.agent/workflows/brainstorm.md +134 -110
  179. package/.agent/workflows/changelog.md +140 -112
  180. package/.agent/workflows/create.md +168 -124
  181. package/.agent/workflows/debug.md +190 -165
  182. package/.agent/workflows/deploy.md +201 -180
  183. package/.agent/workflows/enhance.md +154 -128
  184. package/.agent/workflows/fix.md +136 -114
  185. package/.agent/workflows/generate.md +198 -183
  186. package/.agent/workflows/marathon.md +37 -11
  187. package/.agent/workflows/migrate.md +184 -160
  188. package/.agent/workflows/orchestrate.md +192 -168
  189. package/.agent/workflows/performance-benchmarker.md +135 -114
  190. package/.agent/workflows/plan.md +196 -173
  191. package/.agent/workflows/preview.md +103 -80
  192. package/.agent/workflows/refactor.md +192 -161
  193. package/.agent/workflows/review-ai.md +125 -101
  194. package/.agent/workflows/review.md +141 -116
  195. package/.agent/workflows/session.md +122 -94
  196. package/.agent/workflows/status.md +101 -79
  197. package/.agent/workflows/strengthen-skills.md +164 -138
  198. package/.agent/workflows/super-prompt.md +24 -0
  199. package/.agent/workflows/swarm.md +193 -179
  200. package/.agent/workflows/test.md +211 -189
  201. package/.agent/workflows/tribunal-backend.md +136 -105
  202. package/.agent/workflows/tribunal-database.md +122 -95
  203. package/.agent/workflows/tribunal-frontend.md +221 -96
  204. package/.agent/workflows/tribunal-full.md +129 -100
  205. package/.agent/workflows/tribunal-mobile.md +122 -95
  206. package/.agent/workflows/tribunal-performance.md +136 -110
  207. package/.agent/workflows/tribunal-speed.md +209 -183
  208. package/.agent/workflows/ui-ux-pro-max.md +145 -122
  209. package/README.md +107 -55
  210. package/bin/mcp-server.js +159 -0
  211. package/bin/tribunal-kit.js +105 -29
  212. package/bin/wrapper.js +16 -7
  213. package/mcp_config.json +9 -0
  214. package/package.json +94 -86
  215. package/scripts/changelog.js +4 -3
  216. package/scripts/validate-payload.js +6 -1
  217. package/scripts/postinstall.js +0 -127
@@ -1,304 +1,312 @@
1
- ---
2
- name: readme-builder
3
- description: Interactive README.md generation specialist. Creates professional, structured README files with badges, installation guides, usage examples, screenshots, and contribution guidelines. Use when asked to create, update, or improve a README file.
4
- allowed-tools: Read, Write, Edit, Glob, Grep
5
- version: 1.0.0
6
- last-updated: 2026-03-19
7
- applies-to-model: gemini-2.5-pro, claude-3-7-sonnet
8
- ---
9
-
10
- ## Hallucination Traps (Read First)
11
- - ❌ Starting a README with the project name as the only heading -> ✅ Lead with what the project DOES, not just what it IS
12
- - ❌ Skipping installation and quick-start sections -> ✅ Users need to run the project in under 60 seconds or they leave
13
- - Using screenshots without alt text -> ✅ All images need descriptive alt text for accessibility and broken image fallback
14
-
15
- ---
16
-
17
-
18
- # README Builder Skill
19
-
20
- ---
21
-
22
- ## Ground Rules
23
-
24
- 1. **Always scan the project first** — read `package.json`, `pyproject.toml`, source files before writing a single line
25
- 2. **No placeholder content** — every section must have real, specific information
26
- 3. **Lead with value** — the first 3 lines must communicate what the project does and who it's for
27
- 4. **Runnable examples** every code block must be copy-paste ready and tested against the actual project
28
-
29
- ---
30
-
31
- ## Discovery Phase (Mandatory Before Writing)
32
-
33
- Before generating any README content, answer these questions by scanning the project:
34
-
35
- ```
36
- 1. What does this project do? (single sentence)
37
- 2. Who is the target user? (developer / end-user / enterprise)
38
- 3. What problem does it solve?
39
- 4. What are the installation prerequisites?
40
- 5. What is the primary command or API entry point?
41
- 6. Does it have a license file?
42
- 7. Are there screenshots, demos, or GIFs available?
43
- 8. Is there a CONTRIBUTING.md or CODE_OF_CONDUCT.md?
44
- 9. What CI/CD badges are relevant? (GitHub Actions, npm, PyPI, etc.)
45
- 10. What is the current version?
46
- ```
47
-
48
- ---
49
-
50
- ## README Structure Template
51
-
52
- ```markdown
53
- # [Project Name]
54
-
55
- [One-line tagline: what it does and for whom]
56
-
57
- [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
58
- [![Version](https://img.shields.io/npm/v/package-name)](https://www.npmjs.com/package/package-name)
59
- [![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)](https://github.com/user/repo/actions)
60
-
61
- [Optional: Screenshot or GIF Demo]
62
-
63
- ---
64
-
65
- ## ✨ Features
66
-
67
- - **Feature 1** — specific, concrete description
68
- - **Feature 2** — specific, concrete description
69
- - **Feature 3** — specific, concrete description
70
-
71
- ---
72
-
73
- ## 📋 Prerequisites
74
-
75
- - Node.js 18+ / Python 3.11+ / etc.
76
- - [Any specific tool or account required]
77
-
78
- ---
79
-
80
- ## 🚀 Installation
81
-
82
- ```bash
83
- # npm
84
- npm install package-name
85
-
86
- # or yarn
87
- yarn add package-name
88
-
89
- # or global CLI install
90
- npm install -g package-name
91
- ```
92
-
93
- ---
94
-
95
- ## 💻 Usage
96
-
97
- ### Basic Example
98
-
99
- ```bash
100
- # One-liner that shows the most common use case
101
- package-name --flag value
102
- ```
103
-
104
- ### Advanced Example
105
-
106
- ```bash
107
- # More complex real-world usage
108
- package-name init --config ./config.json --output ./dist
109
- ```
110
-
111
- ---
112
-
113
- ## ⚙️ Configuration
114
-
115
- |Option|Type|Default|Description|
116
- |--------|------|---------|-------------|
117
- |`option1`|`string`|`"default"`|What it controls|
118
- |`option2`|`boolean`|`false`|What it controls|
119
-
120
- ---
121
-
122
- ## 🤝 Contributing
123
-
124
- 1. Fork the repository
125
- 2. Create a feature branch: `git checkout -b feat/your-feature`
126
- 3. Commit changes: `git commit -m "feat: add your feature"`
127
- 4. Push to branch: `git push origin feat/your-feature`
128
- 5. Open a Pull Request
129
-
130
- See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
131
-
132
- ---
133
-
134
- ## 📄 License
135
-
136
- [MIT](LICENSE) © [Author Name]
137
- ```
138
-
139
- ---
140
-
141
- ## Badge Reference
142
-
143
- ### Common Badges (GitHub-hosted project)
144
-
145
- ```markdown
146
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
147
- [![npm version](https://badge.fury.io/js/PACKAGE-NAME.svg)](https://badge.fury.io/js/PACKAGE-NAME)
148
- [![npm downloads](https://img.shields.io/npm/dm/PACKAGE-NAME.svg)](https://www.npmjs.com/package/PACKAGE-NAME)
149
- [![GitHub stars](https://img.shields.io/github/stars/USER/REPO.svg?style=social)](https://github.com/USER/REPO)
150
- [![GitHub issues](https://img.shields.io/github/issues/USER/REPO.svg)](https://github.com/USER/REPO/issues)
151
- [![CI](https://github.com/USER/REPO/workflows/CI/badge.svg)](https://github.com/USER/REPO/actions)
152
- [![Coverage](https://img.shields.io/codecov/c/github/USER/REPO)](https://codecov.io/gh/USER/REPO)
153
- ```
154
-
155
- ---
156
-
157
- ## Section Writing Guidelines
158
-
159
- ### Hero Section (Lines 1–5)
160
- - Project name as `# H1` — only one per README
161
- - Tagline in a `> blockquote` — punchy, one sentence
162
- - Badges immediately after — visual trust signals
163
-
164
- ### Features Section
165
- - Use emoji bullets for scannability
166
- - Each bullet = one concrete capability, not a vague claim
167
- - "Powerful and flexible" "Processes 10k records/sec with zero config"
168
-
169
- ### Installation Section
170
- - Always show the most direct path first (e.g., `npm install`)
171
- - Show alternatives (yarn, pnpm, brew) as secondary options
172
- - If there are post-install steps (env vars, migrations), list them explicitly
173
-
174
- ### Usage Section
175
- - Start with the simplest 1-line example
176
- - Progress to realistic examples with real flag names
177
- - If it's a library, show import + function call pattern
178
-
179
- ### Configuration Table
180
- - Every environment variable or config key goes here
181
- - Include: name, type, default, description
182
- - Mark required fields with `*` in the Description column
183
-
184
- ---
185
-
186
- ## Project-Type Specific Additions
187
-
188
- ### CLI Tools
189
- Add a dedicated `## Commands` section:
190
-
191
- ```markdown
192
- ## Commands
193
-
194
- |Command|Description|
195
- |---------|-------------|
196
- |`tool init`|Initialize a new project|
197
- |`tool build`|Compile and bundle|
198
- |`tool deploy`|Deploy to production|
199
- |`tool --help`|Show all available options|
200
- ```
201
-
202
- ### Libraries / SDKs
203
- Add a `## API Reference` section with function signatures:
204
-
205
- ```markdown
206
- ## API Reference
207
-
208
- ### `functionName(param1, param2)`
209
-
210
- Returns: `ReturnType`
211
-
212
- |Parameter|Type|Description|
213
- |-----------|------|-------------|
214
- |`param1`|`string`|Description|
215
- |`param2`|`options`|Optional config|
216
- ```
217
-
218
- ### Monorepos
219
- Add a `## Packages` table:
220
-
221
- ```markdown
222
- ## Packages
223
-
224
- |Package|Version|Description|
225
- |---------|---------|-------------|
226
- |[`@org/core`](packages/core)|[![npm](https://img.shields.io/npm/v/@org/core)](https://npm.im/@org/core)|Core engine|
227
- |[`@org/cli`](packages/cli)|[![npm](https://img.shields.io/npm/v/@org/cli)](https://npm.im/@org/cli)|CLI interface|
228
- ```
229
-
230
- ---
231
-
232
- ## Output Format
233
-
234
- When this skill generates or reviews a README, structure your response as:
235
-
236
- ```
237
- ━━━ README Builder Report ━━━━━━━━━━━━━━━━━━━━━━━━━
238
- Skill: readme-builder
239
- Project: [project name / type detected]
240
- Sections: [list of sections generated]
241
- ─────────────────────────────────────────────────────
242
- ✅ Included: [sections that are complete]
243
- ⚠️ Missing: [sections that should be added]
244
- ❌ Blocked: [issues preventing completion]
245
- ─────────────────────────────────────────────────────
246
- VBC status: PENDING → VERIFIED
247
- Evidence: [file written at path / content reviewed]
248
- ```
249
-
250
- ---
251
-
252
-
253
- ---
254
-
255
-
256
-
257
- AI coding assistants often fall into specific bad habits when dealing with this domain. These are strictly forbidden:
258
-
259
- 1. **Over-engineering:** Proposing complex abstractions or distributed systems when a simpler approach suffices.
260
- 2. **Hallucinated Libraries/Methods:** Using non-existent methods or packages. Always `// VERIFY` or check `package.json` / `requirements.txt`.
261
- 3. **Skipping Edge Cases:** Writing the "happy path" and ignoring error handling, timeouts, or data validation.
262
- 4. **Context Amnesia:** Forgetting the user's constraints and offering generic advice instead of tailored solutions.
263
- 5. **Silent Degradation:** Catching and suppressing errors without logging or re-raising.
264
-
265
- ---
266
-
267
-
268
-
269
- **Slash command: `/review` or `/tribunal-full`**
270
- **Active reviewers: `logic-reviewer` · `security-auditor`**
271
-
272
- ### ❌ Forbidden AI Tropes
273
-
274
- 1. **Blind Assumptions:** Never make an assumption without documenting it clearly with `// VERIFY: [reason]`.
275
- 2. **Silent Degradation:** Catching and suppressing errors without logging or handling.
276
- 3. **Context Amnesia:** Forgetting the user's constraints and offering generic advice instead of tailored solutions.
277
-
278
-
279
-
280
- Review these questions before confirming output:
281
- ```
282
- ✅ Did I rely ONLY on real, verified tools and methods?
283
- ✅ Is this solution appropriately scoped to the user's constraints?
284
- ✅ Did I handle potential failure modes and edge cases?
285
- ✅ Have I avoided generic boilerplate that doesn't add value?
286
- ```
287
-
288
- ### 🛑 Verification-Before-Completion (VBC) Protocol
289
-
290
- **CRITICAL:** You must follow a strict "evidence-based closeout" state machine.
291
- - ❌ **Forbidden:** Declaring a task complete because the output "looks correct."
292
- - ✅ **Required:** You are explicitly forbidden from finalizing any task without providing **concrete evidence** (terminal output, passing tests, compile success, or equivalent proof) that your output works as intended.
293
-
294
-
295
- ## Pre-Flight Checklist
296
- - [ ] Have I reviewed the user's specific constraints and requests?
297
- - [ ] Have I checked the environment for relevant existing implementations?
298
-
299
- ## VBC Protocol (Verification-Before-Completion)
300
- You MUST verify existing code signatures and variables before attempting to modify or call them. No hallucination is permitted.
1
+ ---
2
+ name: readme-builder
3
+ description: Interactive README.md generation specialist. Creates professional, structured README files with badges, installation guides, usage examples, screenshots, and contribution guidelines. Use when asked to create, update, or improve a README file.
4
+ allowed-tools: Read, Write, Edit, Glob, Grep
5
+ version: 1.0.0
6
+ last-updated: 2026-03-19
7
+ applies-to-model: gemini-2.5-pro, claude-3-7-sonnet
8
+ routing:
9
+ domain: general
10
+ tier: basic
11
+ ---
12
+
13
+ ## Hallucination Traps (Read First)
14
+
15
+ - ❌ Starting a README with the project name as the only heading -> ✅ Lead with what the project DOES, not just what it IS
16
+ - ❌ Skipping installation and quick-start sections -> ✅ Users need to run the project in under 60 seconds or they leave
17
+ - ❌ Using screenshots without alt text -> ✅ All images need descriptive alt text for accessibility and broken image fallback
18
+
19
+ ---
20
+
21
+ # README Builder Skill
22
+
23
+ ---
24
+
25
+ ## Ground Rules
26
+
27
+ 1. **Always scan the project first** read `package.json`, `pyproject.toml`, source files before writing a single line
28
+ 2. **No placeholder content** — every section must have real, specific information
29
+ 3. **Lead with value** — the first 3 lines must communicate what the project does and who it's for
30
+ 4. **Runnable examples** — every code block must be copy-paste ready and tested against the actual project
31
+
32
+ ---
33
+
34
+ ## Discovery Phase (Mandatory Before Writing)
35
+
36
+ Before generating any README content, answer these questions by scanning the project:
37
+
38
+ ```
39
+ 1. What does this project do? (single sentence)
40
+ 2. Who is the target user? (developer / end-user / enterprise)
41
+ 3. What problem does it solve?
42
+ 4. What are the installation prerequisites?
43
+ 5. What is the primary command or API entry point?
44
+ 6. Does it have a license file?
45
+ 7. Are there screenshots, demos, or GIFs available?
46
+ 8. Is there a CONTRIBUTING.md or CODE_OF_CONDUCT.md?
47
+ 9. What CI/CD badges are relevant? (GitHub Actions, npm, PyPI, etc.)
48
+ 10. What is the current version?
49
+ ```
50
+
51
+ ---
52
+
53
+ ## README Structure Template
54
+
55
+ ````markdown
56
+ # [Project Name]
57
+
58
+ [One-line tagline: what it does and for whom]
59
+
60
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
61
+ [![Version](https://img.shields.io/npm/v/package-name)](https://www.npmjs.com/package/package-name)
62
+ [![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)](https://github.com/user/repo/actions)
63
+
64
+ [Optional: Screenshot or GIF Demo]
65
+
66
+ ---
67
+
68
+ ## Features
69
+
70
+ - **Feature 1** — specific, concrete description
71
+ - **Feature 2** — specific, concrete description
72
+ - **Feature 3** — specific, concrete description
73
+
74
+ ---
75
+
76
+ ## 📋 Prerequisites
77
+
78
+ - Node.js 18+ / Python 3.11+ / etc.
79
+ - [Any specific tool or account required]
80
+
81
+ ---
82
+
83
+ ## 🚀 Installation
84
+
85
+ ```bash
86
+ # npm
87
+ npm install package-name
88
+
89
+ # or yarn
90
+ yarn add package-name
91
+
92
+ # or global CLI install
93
+ npm install -g package-name
94
+ ```
95
+ ````
96
+
97
+ ---
98
+
99
+ ## 💻 Usage
100
+
101
+ ### Basic Example
102
+
103
+ ```bash
104
+ # One-liner that shows the most common use case
105
+ package-name --flag value
106
+ ```
107
+
108
+ ### Advanced Example
109
+
110
+ ```bash
111
+ # More complex real-world usage
112
+ package-name init --config ./config.json --output ./dist
113
+ ```
114
+
115
+ ---
116
+
117
+ ## ⚙️ Configuration
118
+
119
+ | Option | Type | Default | Description |
120
+ | --------- | --------- | ----------- | ---------------- |
121
+ | `option1` | `string` | `"default"` | What it controls |
122
+ | `option2` | `boolean` | `false` | What it controls |
123
+
124
+ ---
125
+
126
+ ## 🤝 Contributing
127
+
128
+ 1. Fork the repository
129
+ 2. Create a feature branch: `git checkout -b feat/your-feature`
130
+ 3. Commit changes: `git commit -m "feat: add your feature"`
131
+ 4. Push to branch: `git push origin feat/your-feature`
132
+ 5. Open a Pull Request
133
+
134
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
135
+
136
+ ---
137
+
138
+ ## 📄 License
139
+
140
+ [MIT](LICENSE) © [Author Name]
141
+
142
+ ````
143
+
144
+ ---
145
+
146
+ ## Badge Reference
147
+
148
+ ### Common Badges (GitHub-hosted project)
149
+
150
+ ```markdown
151
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
152
+ [![npm version](https://badge.fury.io/js/PACKAGE-NAME.svg)](https://badge.fury.io/js/PACKAGE-NAME)
153
+ [![npm downloads](https://img.shields.io/npm/dm/PACKAGE-NAME.svg)](https://www.npmjs.com/package/PACKAGE-NAME)
154
+ [![GitHub stars](https://img.shields.io/github/stars/USER/REPO.svg?style=social)](https://github.com/USER/REPO)
155
+ [![GitHub issues](https://img.shields.io/github/issues/USER/REPO.svg)](https://github.com/USER/REPO/issues)
156
+ [![CI](https://github.com/USER/REPO/workflows/CI/badge.svg)](https://github.com/USER/REPO/actions)
157
+ [![Coverage](https://img.shields.io/codecov/c/github/USER/REPO)](https://codecov.io/gh/USER/REPO)
158
+ ````
159
+
160
+ ---
161
+
162
+ ## Section Writing Guidelines
163
+
164
+ ### Hero Section (Lines 1–5)
165
+
166
+ - Project name as `# H1` only one per README
167
+ - Tagline in a `> blockquote` punchy, one sentence
168
+ - Badges immediately after — visual trust signals
169
+
170
+ ### Features Section
171
+
172
+ - Use emoji bullets for scannability
173
+ - Each bullet = one concrete capability, not a vague claim
174
+ - "Powerful and flexible" → ✅ "Processes 10k records/sec with zero config"
175
+
176
+ ### Installation Section
301
177
 
178
+ - Always show the most direct path first (e.g., `npm install`)
179
+ - Show alternatives (yarn, pnpm, brew) as secondary options
180
+ - If there are post-install steps (env vars, migrations), list them explicitly
181
+
182
+ ### Usage Section
183
+
184
+ - Start with the simplest 1-line example
185
+ - Progress to realistic examples with real flag names
186
+ - If it's a library, show import + function call pattern
187
+
188
+ ### Configuration Table
189
+
190
+ - Every environment variable or config key goes here
191
+ - Include: name, type, default, description
192
+ - Mark required fields with `*` in the Description column
193
+
194
+ ---
195
+
196
+ ## Project-Type Specific Additions
197
+
198
+ ### CLI Tools
199
+
200
+ Add a dedicated `## Commands` section:
201
+
202
+ ```markdown
203
+ ## Commands
204
+
205
+ | Command | Description |
206
+ | ------------- | -------------------------- |
207
+ | `tool init` | Initialize a new project |
208
+ | `tool build` | Compile and bundle |
209
+ | `tool deploy` | Deploy to production |
210
+ | `tool --help` | Show all available options |
211
+ ```
212
+
213
+ ### Libraries / SDKs
214
+
215
+ Add a `## API Reference` section with function signatures:
216
+
217
+ ```markdown
218
+ ## API Reference
219
+
220
+ ### `functionName(param1, param2)`
221
+
222
+ Returns: `ReturnType`
223
+
224
+ | Parameter | Type | Description |
225
+ | --------- | --------- | --------------- |
226
+ | `param1` | `string` | Description |
227
+ | `param2` | `options` | Optional config |
228
+ ```
229
+
230
+ ### Monorepos
231
+
232
+ Add a `## Packages` table:
233
+
234
+ ```markdown
235
+ ## Packages
236
+
237
+ | Package | Version | Description |
238
+ | ---------------------------- | -------------------------------------------------------------------------- | ------------- |
239
+ | [`@org/core`](packages/core) | [![npm](https://img.shields.io/npm/v/@org/core)](https://npm.im/@org/core) | Core engine |
240
+ | [`@org/cli`](packages/cli) | [![npm](https://img.shields.io/npm/v/@org/cli)](https://npm.im/@org/cli) | CLI interface |
241
+ ```
242
+
243
+ ---
244
+
245
+ ## Output Format
246
+
247
+ When this skill generates or reviews a README, structure your response as:
248
+
249
+ ```
250
+ ━━━ README Builder Report ━━━━━━━━━━━━━━━━━━━━━━━━━
251
+ Skill: readme-builder
252
+ Project: [project name / type detected]
253
+ Sections: [list of sections generated]
254
+ ─────────────────────────────────────────────────────
255
+ ✅ Included: [sections that are complete]
256
+ ⚠️ Missing: [sections that should be added]
257
+ ❌ Blocked: [issues preventing completion]
258
+ ─────────────────────────────────────────────────────
259
+ VBC status: PENDING → VERIFIED
260
+ Evidence: [file written at path / content reviewed]
261
+ ```
262
+
263
+ ---
264
+
265
+ ---
266
+
267
+ AI coding assistants often fall into specific bad habits when dealing with this domain. These are strictly forbidden:
268
+
269
+ 1. **Over-engineering:** Proposing complex abstractions or distributed systems when a simpler approach suffices.
270
+ 2. **Hallucinated Libraries/Methods:** Using non-existent methods or packages. Always `// VERIFY` or check `package.json` / `requirements.txt`.
271
+ 3. **Skipping Edge Cases:** Writing the "happy path" and ignoring error handling, timeouts, or data validation.
272
+ 4. **Context Amnesia:** Forgetting the user's constraints and offering generic advice instead of tailored solutions.
273
+ 5. **Silent Degradation:** Catching and suppressing errors without logging or re-raising.
274
+
275
+ ---
276
+
277
+ **Slash command: `/review` or `/tribunal-full`**
278
+ **Active reviewers: `logic-reviewer` · `security-auditor`**
279
+
280
+ ### ❌ Forbidden AI Tropes
281
+
282
+ 1. **Blind Assumptions:** Never make an assumption without documenting it clearly with `// VERIFY: [reason]`.
283
+ 2. **Silent Degradation:** Catching and suppressing errors without logging or handling.
284
+ 3. **Context Amnesia:** Forgetting the user's constraints and offering generic advice instead of tailored solutions.
285
+
286
+ Review these questions before confirming output:
287
+
288
+ ```
289
+ ✅ Did I rely ONLY on real, verified tools and methods?
290
+ ✅ Is this solution appropriately scoped to the user's constraints?
291
+ ✅ Did I handle potential failure modes and edge cases?
292
+ ✅ Have I avoided generic boilerplate that doesn't add value?
293
+ ```
294
+
295
+ ### 🛑 Verification-Before-Completion (VBC) Protocol
296
+
297
+ **CRITICAL:** You must follow a strict "evidence-based closeout" state machine.
298
+
299
+ - ❌ **Forbidden:** Declaring a task complete because the output "looks correct."
300
+ - ✅ **Required:** You are explicitly forbidden from finalizing any task without providing **concrete evidence** (terminal output, passing tests, compile success, or equivalent proof) that your output works as intended.
301
+
302
+ ## Pre-Flight Checklist
303
+
304
+ - [ ] Have I reviewed the user's specific constraints and requests?
305
+ - [ ] Have I checked the environment for relevant existing implementations?
306
+
307
+ ## VBC Protocol (Verification-Before-Completion)
308
+
309
+ You MUST verify existing code signatures and variables before attempting to modify or call them. No hallucination is permitted.
302
310
 
303
311
  ---
304
312
 
@@ -328,6 +336,7 @@ AI coding assistants often fall into specific bad habits when dealing with this
328
336
  ### ✅ Pre-Flight Self-Audit
329
337
 
330
338
  Review these questions before confirming output:
339
+
331
340
  ```
332
341
  ✅ Did I rely ONLY on real, verified tools and methods?
333
342
  ✅ Is this solution appropriately scoped to the user's constraints?
@@ -338,5 +347,6 @@ Review these questions before confirming output:
338
347
  ### 🛑 Verification-Before-Completion (VBC) Protocol
339
348
 
340
349
  **CRITICAL:** You must follow a strict "evidence-based closeout" state machine.
350
+
341
351
  - ❌ **Forbidden:** Declaring a task complete because the output "looks correct."
342
352
  - ✅ **Required:** You are explicitly forbidden from finalizing any task without providing **concrete evidence** (terminal output, passing tests, compile success, or equivalent proof) that your output works as intended.