@hivehub/rulebook 4.1.0 → 4.2.1

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 (335) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +137 -1
  19. package/dist/cli/commands.d.ts +18 -6
  20. package/dist/cli/commands.d.ts.map +1 -1
  21. package/dist/cli/commands.js +727 -406
  22. package/dist/cli/commands.js.map +1 -1
  23. package/dist/core/claude-mcp.d.ts +4 -2
  24. package/dist/core/claude-mcp.d.ts.map +1 -1
  25. package/dist/core/claude-mcp.js +14 -9
  26. package/dist/core/claude-mcp.js.map +1 -1
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +13 -0
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/core/indexer/background-indexer.d.ts.map +1 -1
  31. package/dist/core/indexer/background-indexer.js +26 -5
  32. package/dist/core/indexer/background-indexer.js.map +1 -1
  33. package/dist/core/indexer/file-parser.d.ts.map +1 -1
  34. package/dist/core/indexer/file-parser.js +1 -1
  35. package/dist/core/indexer/file-parser.js.map +1 -1
  36. package/dist/core/indexer/indexer-types.d.ts.map +1 -1
  37. package/dist/core/workspace/legacy-migrator.d.ts +29 -0
  38. package/dist/core/workspace/legacy-migrator.d.ts.map +1 -0
  39. package/dist/core/workspace/legacy-migrator.js +142 -0
  40. package/dist/core/workspace/legacy-migrator.js.map +1 -0
  41. package/dist/core/workspace/project-worker.d.ts +49 -0
  42. package/dist/core/workspace/project-worker.d.ts.map +1 -0
  43. package/dist/core/workspace/project-worker.js +108 -0
  44. package/dist/core/workspace/project-worker.js.map +1 -0
  45. package/dist/core/workspace/workspace-manager.d.ts +90 -0
  46. package/dist/core/workspace/workspace-manager.d.ts.map +1 -0
  47. package/dist/core/workspace/workspace-manager.js +347 -0
  48. package/dist/core/workspace/workspace-manager.js.map +1 -0
  49. package/dist/core/workspace/workspace-types.d.ts +37 -0
  50. package/dist/core/workspace/workspace-types.d.ts.map +1 -0
  51. package/dist/core/workspace/workspace-types.js +8 -0
  52. package/dist/core/workspace/workspace-types.js.map +1 -0
  53. package/dist/index.js +43 -7
  54. package/dist/index.js.map +1 -1
  55. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  56. package/dist/mcp/rulebook-server.js +367 -100
  57. package/dist/mcp/rulebook-server.js.map +1 -1
  58. package/dist/memory/memory-manager.js +2 -2
  59. package/dist/memory/memory-manager.js.map +1 -1
  60. package/dist/memory/memory-search.js.map +1 -1
  61. package/dist/memory/memory-store.d.ts.map +1 -1
  62. package/dist/memory/memory-store.js +1 -1
  63. package/dist/memory/memory-store.js.map +1 -1
  64. package/dist/types.d.ts +1 -0
  65. package/dist/types.d.ts.map +1 -1
  66. package/package.json +22 -21
  67. package/templates/agents/implementer.md +35 -35
  68. package/templates/agents/researcher.md +34 -34
  69. package/templates/agents/team-lead.md +34 -34
  70. package/templates/agents/tester.md +42 -42
  71. package/templates/ci/rulebook-review.yml +26 -26
  72. package/templates/cli/AIDER.md +49 -49
  73. package/templates/cli/AMAZON_Q.md +25 -25
  74. package/templates/cli/AUGGIE.md +32 -32
  75. package/templates/cli/CLAUDE.md +117 -117
  76. package/templates/cli/CLINE.md +99 -99
  77. package/templates/cli/CODEBUDDY.md +20 -20
  78. package/templates/cli/CODEIUM.md +20 -20
  79. package/templates/cli/CODEX.md +21 -21
  80. package/templates/cli/CONTINUE.md +34 -34
  81. package/templates/cli/CURSOR_CLI.md +62 -62
  82. package/templates/cli/FACTORY.md +18 -18
  83. package/templates/cli/GEMINI.md +35 -35
  84. package/templates/cli/KILOCODE.md +18 -18
  85. package/templates/cli/OPENCODE.md +18 -18
  86. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  87. package/templates/commands/rulebook-memory-save.md +48 -48
  88. package/templates/commands/rulebook-memory-search.md +47 -47
  89. package/templates/commands/rulebook-task-apply.md +67 -67
  90. package/templates/commands/rulebook-task-archive.md +94 -94
  91. package/templates/commands/rulebook-task-create.md +93 -93
  92. package/templates/commands/rulebook-task-list.md +42 -42
  93. package/templates/commands/rulebook-task-show.md +52 -52
  94. package/templates/commands/rulebook-task-validate.md +53 -53
  95. package/templates/core/AGENTS_LEAN.md +25 -25
  96. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  97. package/templates/core/AGENT_AUTOMATION.md +288 -288
  98. package/templates/core/DAG.md +304 -304
  99. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  100. package/templates/core/MULTI_AGENT.md +74 -74
  101. package/templates/core/PLANS.md +28 -28
  102. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  103. package/templates/core/RALPH.md +471 -471
  104. package/templates/core/RULEBOOK.md +1935 -1935
  105. package/templates/core/WORKSPACE.md +69 -0
  106. package/templates/frameworks/ANGULAR.md +36 -36
  107. package/templates/frameworks/DJANGO.md +83 -83
  108. package/templates/frameworks/ELECTRON.md +147 -147
  109. package/templates/frameworks/FLASK.md +38 -38
  110. package/templates/frameworks/FLUTTER.md +55 -55
  111. package/templates/frameworks/JQUERY.md +32 -32
  112. package/templates/frameworks/LARAVEL.md +38 -38
  113. package/templates/frameworks/NESTJS.md +43 -43
  114. package/templates/frameworks/NEXTJS.md +127 -127
  115. package/templates/frameworks/NUXT.md +40 -40
  116. package/templates/frameworks/RAILS.md +66 -66
  117. package/templates/frameworks/REACT.md +38 -38
  118. package/templates/frameworks/REACT_NATIVE.md +47 -47
  119. package/templates/frameworks/SPRING.md +39 -39
  120. package/templates/frameworks/SYMFONY.md +36 -36
  121. package/templates/frameworks/VUE.md +36 -36
  122. package/templates/frameworks/ZEND.md +35 -35
  123. package/templates/git/CI_CD_PATTERNS.md +661 -661
  124. package/templates/git/GITHUB_ACTIONS.md +728 -728
  125. package/templates/git/GITLAB_CI.md +730 -730
  126. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  127. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  128. package/templates/hooks/COMMIT_MSG.md +530 -530
  129. package/templates/hooks/POST_CHECKOUT.md +546 -546
  130. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  131. package/templates/hooks/PRE_COMMIT.md +414 -414
  132. package/templates/hooks/PRE_PUSH.md +601 -601
  133. package/templates/ides/CONTINUE_RULES.md +16 -16
  134. package/templates/ides/COPILOT.md +37 -37
  135. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  136. package/templates/ides/CURSOR.md +43 -43
  137. package/templates/ides/GEMINI_RULES.md +17 -17
  138. package/templates/ides/JETBRAINS_AI.md +35 -35
  139. package/templates/ides/REPLIT.md +36 -36
  140. package/templates/ides/TABNINE.md +29 -29
  141. package/templates/ides/VSCODE.md +40 -40
  142. package/templates/ides/WINDSURF.md +36 -36
  143. package/templates/ides/WINDSURF_RULES.md +14 -14
  144. package/templates/ides/ZED.md +32 -32
  145. package/templates/ides/cursor-mdc/go.mdc +24 -24
  146. package/templates/ides/cursor-mdc/python.mdc +24 -24
  147. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  148. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  149. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  150. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  151. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  152. package/templates/languages/C.md +333 -333
  153. package/templates/languages/CPP.md +743 -743
  154. package/templates/languages/CSHARP.md +417 -417
  155. package/templates/languages/ELIXIR.md +454 -454
  156. package/templates/languages/ERLANG.md +361 -361
  157. package/templates/languages/GO.md +645 -645
  158. package/templates/languages/HASKELL.md +177 -177
  159. package/templates/languages/JAVA.md +607 -607
  160. package/templates/languages/JAVASCRIPT.md +631 -631
  161. package/templates/languages/JULIA.md +97 -97
  162. package/templates/languages/KOTLIN.md +511 -511
  163. package/templates/languages/LISP.md +100 -100
  164. package/templates/languages/LUA.md +74 -74
  165. package/templates/languages/OBJECTIVEC.md +90 -90
  166. package/templates/languages/PHP.md +416 -416
  167. package/templates/languages/PYTHON.md +682 -682
  168. package/templates/languages/RUBY.md +421 -421
  169. package/templates/languages/RUST.md +477 -477
  170. package/templates/languages/SAS.md +73 -73
  171. package/templates/languages/SCALA.md +348 -348
  172. package/templates/languages/SOLIDITY.md +580 -580
  173. package/templates/languages/SQL.md +137 -137
  174. package/templates/languages/SWIFT.md +466 -466
  175. package/templates/languages/TYPESCRIPT.md +591 -591
  176. package/templates/languages/ZIG.md +265 -265
  177. package/templates/modules/ATLASSIAN.md +255 -255
  178. package/templates/modules/CONTEXT7.md +54 -54
  179. package/templates/modules/FIGMA.md +267 -267
  180. package/templates/modules/GITHUB_MCP.md +64 -64
  181. package/templates/modules/GRAFANA.md +328 -328
  182. package/templates/modules/MEMORY.md +126 -126
  183. package/templates/modules/NOTION.md +247 -247
  184. package/templates/modules/PLAYWRIGHT.md +90 -90
  185. package/templates/modules/RULEBOOK_MCP.md +156 -156
  186. package/templates/modules/SERENA.md +337 -337
  187. package/templates/modules/SUPABASE.md +223 -223
  188. package/templates/modules/SYNAP.md +69 -69
  189. package/templates/modules/VECTORIZER.md +63 -63
  190. package/templates/modules/sequential-thinking.md +42 -42
  191. package/templates/ralph/ralph-history.bat +4 -4
  192. package/templates/ralph/ralph-history.sh +5 -5
  193. package/templates/ralph/ralph-init.bat +5 -5
  194. package/templates/ralph/ralph-init.sh +5 -5
  195. package/templates/ralph/ralph-pause.bat +5 -5
  196. package/templates/ralph/ralph-pause.sh +5 -5
  197. package/templates/ralph/ralph-run.bat +5 -5
  198. package/templates/ralph/ralph-run.sh +5 -5
  199. package/templates/ralph/ralph-status.bat +4 -4
  200. package/templates/ralph/ralph-status.sh +5 -5
  201. package/templates/services/AZURE_BLOB.md +184 -184
  202. package/templates/services/CASSANDRA.md +239 -239
  203. package/templates/services/DATADOG.md +26 -26
  204. package/templates/services/DOCKER.md +124 -124
  205. package/templates/services/DOCKER_COMPOSE.md +168 -168
  206. package/templates/services/DYNAMODB.md +308 -308
  207. package/templates/services/ELASTICSEARCH.md +347 -347
  208. package/templates/services/GCS.md +178 -178
  209. package/templates/services/HELM.md +194 -194
  210. package/templates/services/INFLUXDB.md +265 -265
  211. package/templates/services/KAFKA.md +341 -341
  212. package/templates/services/KUBERNETES.md +208 -208
  213. package/templates/services/MARIADB.md +183 -183
  214. package/templates/services/MEMCACHED.md +242 -242
  215. package/templates/services/MINIO.md +201 -201
  216. package/templates/services/MONGODB.md +268 -268
  217. package/templates/services/MYSQL.md +358 -358
  218. package/templates/services/NEO4J.md +247 -247
  219. package/templates/services/OPENTELEMETRY.md +25 -25
  220. package/templates/services/ORACLE.md +290 -290
  221. package/templates/services/PINO.md +24 -24
  222. package/templates/services/POSTGRESQL.md +326 -326
  223. package/templates/services/PROMETHEUS.md +33 -33
  224. package/templates/services/RABBITMQ.md +286 -286
  225. package/templates/services/REDIS.md +292 -292
  226. package/templates/services/S3.md +298 -298
  227. package/templates/services/SENTRY.md +23 -23
  228. package/templates/services/SQLITE.md +294 -294
  229. package/templates/services/SQLSERVER.md +294 -294
  230. package/templates/services/WINSTON.md +30 -30
  231. package/templates/skills/cli/aider/SKILL.md +59 -59
  232. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  233. package/templates/skills/cli/auggie/SKILL.md +42 -42
  234. package/templates/skills/cli/claude/SKILL.md +42 -42
  235. package/templates/skills/cli/cline/SKILL.md +42 -42
  236. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  237. package/templates/skills/cli/codeium/SKILL.md +30 -30
  238. package/templates/skills/cli/codex/SKILL.md +31 -31
  239. package/templates/skills/cli/continue/SKILL.md +44 -44
  240. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  241. package/templates/skills/cli/factory/SKILL.md +28 -28
  242. package/templates/skills/cli/gemini/SKILL.md +45 -45
  243. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  244. package/templates/skills/cli/opencode/SKILL.md +28 -28
  245. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  246. package/templates/skills/core/dag/SKILL.md +314 -314
  247. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  248. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  249. package/templates/skills/core/rulebook/SKILL.md +176 -176
  250. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  251. package/templates/skills/frameworks/django/SKILL.md +93 -93
  252. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  253. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  254. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  255. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  256. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  257. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  258. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  259. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  260. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  261. package/templates/skills/frameworks/react/SKILL.md +48 -48
  262. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  263. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  264. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  265. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  266. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  267. package/templates/skills/ides/copilot/SKILL.md +47 -47
  268. package/templates/skills/ides/cursor/SKILL.md +53 -53
  269. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  270. package/templates/skills/ides/replit/SKILL.md +46 -46
  271. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  272. package/templates/skills/ides/vscode/SKILL.md +50 -50
  273. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  274. package/templates/skills/ides/zed/SKILL.md +42 -42
  275. package/templates/skills/languages/c/SKILL.md +343 -343
  276. package/templates/skills/languages/cpp/SKILL.md +753 -753
  277. package/templates/skills/languages/csharp/SKILL.md +427 -427
  278. package/templates/skills/languages/elixir/SKILL.md +464 -464
  279. package/templates/skills/languages/erlang/SKILL.md +371 -371
  280. package/templates/skills/languages/go/SKILL.md +655 -655
  281. package/templates/skills/languages/haskell/SKILL.md +187 -187
  282. package/templates/skills/languages/java/SKILL.md +617 -617
  283. package/templates/skills/languages/javascript/SKILL.md +641 -641
  284. package/templates/skills/languages/julia/SKILL.md +107 -107
  285. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  286. package/templates/skills/languages/lisp/SKILL.md +110 -110
  287. package/templates/skills/languages/lua/SKILL.md +84 -84
  288. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  289. package/templates/skills/languages/php/SKILL.md +426 -426
  290. package/templates/skills/languages/python/SKILL.md +692 -692
  291. package/templates/skills/languages/ruby/SKILL.md +431 -431
  292. package/templates/skills/languages/rust/SKILL.md +487 -487
  293. package/templates/skills/languages/sas/SKILL.md +83 -83
  294. package/templates/skills/languages/scala/SKILL.md +358 -358
  295. package/templates/skills/languages/solidity/SKILL.md +590 -590
  296. package/templates/skills/languages/sql/SKILL.md +147 -147
  297. package/templates/skills/languages/swift/SKILL.md +476 -476
  298. package/templates/skills/languages/typescript/SKILL.md +302 -302
  299. package/templates/skills/languages/zig/SKILL.md +275 -275
  300. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  301. package/templates/skills/modules/context7/SKILL.md +64 -64
  302. package/templates/skills/modules/figma/SKILL.md +277 -277
  303. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  304. package/templates/skills/modules/grafana/SKILL.md +338 -338
  305. package/templates/skills/modules/memory/SKILL.md +73 -73
  306. package/templates/skills/modules/notion/SKILL.md +257 -257
  307. package/templates/skills/modules/playwright/SKILL.md +100 -100
  308. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  309. package/templates/skills/modules/serena/SKILL.md +347 -347
  310. package/templates/skills/modules/supabase/SKILL.md +233 -233
  311. package/templates/skills/modules/synap/SKILL.md +79 -79
  312. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  313. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  314. package/templates/skills/services/cassandra/SKILL.md +249 -249
  315. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  316. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  317. package/templates/skills/services/gcs/SKILL.md +188 -188
  318. package/templates/skills/services/influxdb/SKILL.md +275 -275
  319. package/templates/skills/services/kafka/SKILL.md +351 -351
  320. package/templates/skills/services/mariadb/SKILL.md +193 -193
  321. package/templates/skills/services/memcached/SKILL.md +252 -252
  322. package/templates/skills/services/minio/SKILL.md +211 -211
  323. package/templates/skills/services/mongodb/SKILL.md +278 -278
  324. package/templates/skills/services/mysql/SKILL.md +368 -368
  325. package/templates/skills/services/neo4j/SKILL.md +257 -257
  326. package/templates/skills/services/oracle/SKILL.md +300 -300
  327. package/templates/skills/services/postgresql/SKILL.md +336 -336
  328. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  329. package/templates/skills/services/redis/SKILL.md +302 -302
  330. package/templates/skills/services/s3/SKILL.md +308 -308
  331. package/templates/skills/services/sqlite/SKILL.md +304 -304
  332. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  333. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  334. package/templates/skills/workflows/ralph/install.sh +87 -87
  335. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,47 +1,47 @@
1
- ---
2
- name: "Documentation Rules"
3
- description: "All documentation in English. Root README concise, detailed docs in `/docs`."
4
- version: "1.0.0"
5
- category: "core"
6
- author: "Rulebook"
7
- tags: ["core"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- # Documentation Standards
12
-
13
- **CRITICAL**: All documentation in English. Root README concise, detailed docs in `/docs`.
14
-
15
- ## Structure
16
-
17
- **Root-Level (ONLY):**
18
- - `README.md` - Overview + quick start
19
- - `CHANGELOG.md` - Version history
20
- - `AGENTS.md` - AI instructions
21
- - `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`
22
-
23
- **All Other Docs in `/docs`:**
24
- - `ARCHITECTURE.md`, `DEVELOPMENT.md`, `ROADMAP.md`
25
- - `specs/`, `guides/`, `diagrams/`, `benchmarks/`
26
-
27
- ## Update Requirements by Commit Type
28
-
29
- | Type | Update |
30
- |------|--------|
31
- | `feat` | README features, API docs, CHANGELOG "Added" |
32
- | `fix` | Troubleshooting, CHANGELOG "Fixed" |
33
- | `breaking` | CHANGELOG + migration guide, version docs |
34
- | `perf` | Benchmarks, CHANGELOG "Performance" |
35
- | `security` | SECURITY.md, CHANGELOG "Security" |
36
- | `docs` | Verify spelling/links only |
37
- | `refactor` | Update if behavior changed |
38
-
39
- ## Quality Checks (CI/CD)
40
-
41
- ```bash
42
- markdownlint **/*.md # Lint markdown
43
- markdown-link-check **/*.md # Check links
44
- codespell **/*.md # Spell check
45
- ```
46
-
1
+ ---
2
+ name: "Documentation Rules"
3
+ description: "All documentation in English. Root README concise, detailed docs in `/docs`."
4
+ version: "1.0.0"
5
+ category: "core"
6
+ author: "Rulebook"
7
+ tags: ["core"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+ # Documentation Standards
12
+
13
+ **CRITICAL**: All documentation in English. Root README concise, detailed docs in `/docs`.
14
+
15
+ ## Structure
16
+
17
+ **Root-Level (ONLY):**
18
+ - `README.md` - Overview + quick start
19
+ - `CHANGELOG.md` - Version history
20
+ - `AGENTS.md` - AI instructions
21
+ - `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`
22
+
23
+ **All Other Docs in `/docs`:**
24
+ - `ARCHITECTURE.md`, `DEVELOPMENT.md`, `ROADMAP.md`
25
+ - `specs/`, `guides/`, `diagrams/`, `benchmarks/`
26
+
27
+ ## Update Requirements by Commit Type
28
+
29
+ | Type | Update |
30
+ |------|--------|
31
+ | `feat` | README features, API docs, CHANGELOG "Added" |
32
+ | `fix` | Troubleshooting, CHANGELOG "Fixed" |
33
+ | `breaking` | CHANGELOG + migration guide, version docs |
34
+ | `perf` | Benchmarks, CHANGELOG "Performance" |
35
+ | `security` | SECURITY.md, CHANGELOG "Security" |
36
+ | `docs` | Verify spelling/links only |
37
+ | `refactor` | Update if behavior changed |
38
+
39
+ ## Quality Checks (CI/CD)
40
+
41
+ ```bash
42
+ markdownlint **/*.md # Lint markdown
43
+ markdown-link-check **/*.md # Check links
44
+ codespell **/*.md # Spell check
45
+ ```
46
+
47
47
  **MUST pass before commit** (see AGENT_AUTOMATION).
@@ -1,78 +1,78 @@
1
- ---
2
- name: "Quality Enforcement"
3
- description: "These rules are NON-NEGOTIABLE and MUST be followed without exception."
4
- version: "1.0.0"
5
- category: "core"
6
- author: "Rulebook"
7
- tags: ["core"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- QUALITY_ENFORCEMENT:START -->
12
- # Quality Enforcement Rules
13
-
14
- **CRITICAL**: These rules are NON-NEGOTIABLE and MUST be followed without exception.
15
-
16
- ## Absolute Prohibitions
17
-
18
- ### Test Bypassing - STRICTLY FORBIDDEN
19
- - NEVER use .skip(), .only(), or .todo() to bypass failing tests
20
- - NEVER comment out failing tests
21
- - NEVER use @ts-ignore, @ts-expect-error, or similar to hide test errors
22
- - NEVER mock/stub functionality just to make tests pass without fixing root cause
23
- - FIX the actual problem causing test failures
24
-
25
- ### Git Hook Bypassing - STRICTLY FORBIDDEN
26
- - NEVER use --no-verify flag on git commit
27
- - NEVER use --no-verify flag on git push
28
- - NEVER disable or skip pre-commit hooks
29
- - NEVER disable or skip pre-push hooks
30
- - FIX the issues that hooks are detecting
31
-
32
- ### Test Implementation - STRICTLY FORBIDDEN
33
- - NEVER create boilerplate tests that don't actually test behavior
34
- - NEVER write tests that always pass regardless of implementation
35
- - NEVER write tests without assertions
36
- - NEVER mock everything to avoid testing real behavior
37
- - WRITE meaningful tests that verify actual functionality
38
-
39
- ### Problem Solving Approach - REQUIRED
40
- - DO NOT seek the simplest bypass or workaround
41
- - DO NOT be creative with shortcuts that compromise quality
42
- - DO solve problems properly following best practices
43
- - DO use proven, established solutions from decades of experience
44
- - DO fix root causes, not symptoms
45
-
46
- ### Temporary Files and Scripts - STRICTLY FORBIDDEN
47
- - **NEVER** create temporary files in project root or any directory outside `/scripts`
48
- - **NEVER** create test files, log files, or debug files outside `/scripts`
49
- - **NEVER** leave temporary files after use - they MUST be deleted immediately
50
- - **ALWAYS** create all scripts inside `/scripts` directory
51
- - **ALWAYS** remove temporary files immediately after use (MANDATORY)
52
- - **ALWAYS** clean up test artifacts, log files, and debug files before committing
53
- - **ALWAYS** use `/scripts` directory for any temporary scripts or test files
54
-
55
- **Why This Matters:**
56
- LLM assistants often create temporary files for testing but forget to remove them, accumulating dozens of junk files that pollute the repository. All temporary work MUST be done in `/scripts` and cleaned up immediately.
57
-
58
- **Examples:**
59
- - ❌ Creating `test.js`, `debug.log`, `temp.json` in project root
60
- - ❌ Leaving test files after debugging
61
- - ❌ Creating scripts outside `/scripts` directory
62
- - ✅ Creating `/scripts/test-feature.js` and removing it after use
63
- - ✅ Using `/scripts` for all temporary work
64
- - ✅ Cleaning up all temporary files before committing
65
-
66
- ## Enforcement
67
-
68
- These rules apply to ALL implementations:
69
- - Bug fixes
70
- - New features
71
- - Refactoring
72
- - Documentation changes
73
- - Any code modifications
74
-
75
- **Violation = Implementation Rejected**
76
-
77
- <!-- QUALITY_ENFORCEMENT:END -->
78
-
1
+ ---
2
+ name: "Quality Enforcement"
3
+ description: "These rules are NON-NEGOTIABLE and MUST be followed without exception."
4
+ version: "1.0.0"
5
+ category: "core"
6
+ author: "Rulebook"
7
+ tags: ["core"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+ <!-- QUALITY_ENFORCEMENT:START -->
12
+ # Quality Enforcement Rules
13
+
14
+ **CRITICAL**: These rules are NON-NEGOTIABLE and MUST be followed without exception.
15
+
16
+ ## Absolute Prohibitions
17
+
18
+ ### Test Bypassing - STRICTLY FORBIDDEN
19
+ - NEVER use .skip(), .only(), or .todo() to bypass failing tests
20
+ - NEVER comment out failing tests
21
+ - NEVER use @ts-ignore, @ts-expect-error, or similar to hide test errors
22
+ - NEVER mock/stub functionality just to make tests pass without fixing root cause
23
+ - FIX the actual problem causing test failures
24
+
25
+ ### Git Hook Bypassing - STRICTLY FORBIDDEN
26
+ - NEVER use --no-verify flag on git commit
27
+ - NEVER use --no-verify flag on git push
28
+ - NEVER disable or skip pre-commit hooks
29
+ - NEVER disable or skip pre-push hooks
30
+ - FIX the issues that hooks are detecting
31
+
32
+ ### Test Implementation - STRICTLY FORBIDDEN
33
+ - NEVER create boilerplate tests that don't actually test behavior
34
+ - NEVER write tests that always pass regardless of implementation
35
+ - NEVER write tests without assertions
36
+ - NEVER mock everything to avoid testing real behavior
37
+ - WRITE meaningful tests that verify actual functionality
38
+
39
+ ### Problem Solving Approach - REQUIRED
40
+ - DO NOT seek the simplest bypass or workaround
41
+ - DO NOT be creative with shortcuts that compromise quality
42
+ - DO solve problems properly following best practices
43
+ - DO use proven, established solutions from decades of experience
44
+ - DO fix root causes, not symptoms
45
+
46
+ ### Temporary Files and Scripts - STRICTLY FORBIDDEN
47
+ - **NEVER** create temporary files in project root or any directory outside `/scripts`
48
+ - **NEVER** create test files, log files, or debug files outside `/scripts`
49
+ - **NEVER** leave temporary files after use - they MUST be deleted immediately
50
+ - **ALWAYS** create all scripts inside `/scripts` directory
51
+ - **ALWAYS** remove temporary files immediately after use (MANDATORY)
52
+ - **ALWAYS** clean up test artifacts, log files, and debug files before committing
53
+ - **ALWAYS** use `/scripts` directory for any temporary scripts or test files
54
+
55
+ **Why This Matters:**
56
+ LLM assistants often create temporary files for testing but forget to remove them, accumulating dozens of junk files that pollute the repository. All temporary work MUST be done in `/scripts` and cleaned up immediately.
57
+
58
+ **Examples:**
59
+ - ❌ Creating `test.js`, `debug.log`, `temp.json` in project root
60
+ - ❌ Leaving test files after debugging
61
+ - ❌ Creating scripts outside `/scripts` directory
62
+ - ✅ Creating `/scripts/test-feature.js` and removing it after use
63
+ - ✅ Using `/scripts` for all temporary work
64
+ - ✅ Cleaning up all temporary files before committing
65
+
66
+ ## Enforcement
67
+
68
+ These rules apply to ALL implementations:
69
+ - Bug fixes
70
+ - New features
71
+ - Refactoring
72
+ - Documentation changes
73
+ - Any code modifications
74
+
75
+ **Violation = Implementation Rejected**
76
+
77
+ <!-- QUALITY_ENFORCEMENT:END -->
78
+
@@ -1,176 +1,176 @@
1
- ---
2
- name: "Rulebook Task Management"
3
- description: "Spec-driven task management for features and breaking changes with OpenSpec-compatible format"
4
- version: "1.0.0"
5
- category: "core"
6
- author: "Rulebook"
7
- tags: ["task-management", "openspec", "spec-driven", "workflow"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
-
12
- # Rulebook Task Management
13
-
14
- **CRITICAL**: Use Rulebook's built-in task management system for spec-driven development of new features and breaking changes.
15
-
16
- ## When to Use
17
-
18
- Create tasks for:
19
- - New features/capabilities
20
- - Breaking changes
21
- - Architecture changes
22
- - Performance/security work
23
-
24
- Skip for:
25
- - Bug fixes (restore intended behavior)
26
- - Typos, formatting, comments
27
- - Dependency updates (non-breaking)
28
-
29
- ## Task Creation is MANDATORY Before Implementation
30
-
31
- **ABSOLUTE RULE**: You MUST create a task BEFORE implementing ANY feature.
32
-
33
- ### MANDATORY Workflow
34
-
35
- **NEVER start implementation without creating a task first:**
36
-
37
- ```bash
38
- # WRONG: Starting implementation directly
39
- # ... writing code without task ...
40
-
41
- # CORRECT: Create task first
42
- rulebook task create <task-id>
43
- # Write proposal.md
44
- # Write tasks.md
45
- # Write spec deltas
46
- rulebook task validate <task-id>
47
- # NOW you can start implementation
48
- ```
49
-
50
- ### Task Creation Steps
51
-
52
- **When a feature is requested:**
53
-
54
- 1. **STOP** - Do not start coding
55
- 2. **Create task** - `rulebook task create <task-id>`
56
- 3. **Plan** - Write proposal.md and tasks.md
57
- 4. **Spec** - Write spec deltas
58
- 5. **Validate** - `rulebook task validate <task-id>`
59
- 6. **THEN** - Start implementation
60
-
61
- ## Task Directory Structure
62
-
63
- ```
64
- .rulebook/tasks/<task-id>/
65
- ├── proposal.md # Why and what changes
66
- ├── tasks.md # Implementation checklist
67
- ├── design.md # Technical design (optional)
68
- └── specs/
69
- └── <module>/
70
- └── spec.md # Technical specifications
71
- ```
72
-
73
- ## Task Commands
74
-
75
- ```bash
76
- # Create new task
77
- rulebook task create <task-id>
78
-
79
- # List all tasks
80
- rulebook task list
81
-
82
- # Show task details
83
- rulebook task show <task-id>
84
-
85
- # Validate task structure
86
- rulebook task validate <task-id>
87
-
88
- # Archive completed task
89
- rulebook task archive <task-id>
90
- ```
91
-
92
- ## Proposal Format (proposal.md)
93
-
94
- ```markdown
95
- # Proposal: <Task Title>
96
-
97
- ## Why
98
- <Explain the problem or opportunity>
99
-
100
- ## What Changes
101
- <List of changes with ADDED/MODIFIED/REMOVED markers>
102
-
103
- ## Impact
104
- - Affected specs: <list spec files>
105
- - Affected code: <list source files>
106
- - Breaking change: YES/NO
107
- - User benefit: <describe benefit>
108
- ```
109
-
110
- ## Tasks Format (tasks.md)
111
-
112
- **CRITICAL**: Only simple checklist items. Technical details go in specs.
113
-
114
- ```markdown
115
- ## 1. <Phase Name>
116
- - [ ] 1.1 <Simple task description>
117
- - [ ] 1.2 <Simple task description>
118
-
119
- ## 2. <Phase Name>
120
- - [ ] 2.1 <Simple task description>
121
- ```
122
-
123
- ## Spec Delta Format (specs/<module>/spec.md)
124
-
125
- ```markdown
126
- # <Module> Specification
127
-
128
- ## ADDED Requirements
129
-
130
- ### Requirement: <Name>
131
- <Description>
132
-
133
- #### Scenario: <Name>
134
- Given <context>
135
- When <action>
136
- Then <expected result>
137
-
138
- ## MODIFIED Requirements
139
-
140
- ### Requirement: <Original Name>
141
- <Description of modification>
142
-
143
- ## REMOVED Requirements
144
-
145
- ### Requirement: <Name to Remove>
146
- <Reason for removal>
147
- ```
148
-
149
- ## MCP Integration
150
-
151
- If MCP server is enabled, use programmatic task management:
152
-
153
- ```typescript
154
- // Create task
155
- await mcp.rulebook_task_create({ taskId: "my-task" });
156
-
157
- // List tasks
158
- await mcp.rulebook_task_list({});
159
-
160
- // Show task
161
- await mcp.rulebook_task_show({ taskId: "my-task" });
162
-
163
- // Validate task
164
- await mcp.rulebook_task_validate({ taskId: "my-task" });
165
-
166
- // Archive task
167
- await mcp.rulebook_task_archive({ taskId: "my-task" });
168
- ```
169
-
170
- ## Best Practices
171
-
172
- 1. **Always create task first** - Never implement without documentation
173
- 2. **Keep tasks.md simple** - Only checklist items, no explanations
174
- 3. **Put details in specs** - Technical requirements go in spec files
175
- 4. **Validate before implementing** - Run `rulebook task validate`
176
- 5. **Archive when done** - Move completed tasks to archive
1
+ ---
2
+ name: "Rulebook Task Management"
3
+ description: "Spec-driven task management for features and breaking changes with OpenSpec-compatible format"
4
+ version: "1.0.0"
5
+ category: "core"
6
+ author: "Rulebook"
7
+ tags: ["task-management", "openspec", "spec-driven", "workflow"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+
12
+ # Rulebook Task Management
13
+
14
+ **CRITICAL**: Use Rulebook's built-in task management system for spec-driven development of new features and breaking changes.
15
+
16
+ ## When to Use
17
+
18
+ Create tasks for:
19
+ - New features/capabilities
20
+ - Breaking changes
21
+ - Architecture changes
22
+ - Performance/security work
23
+
24
+ Skip for:
25
+ - Bug fixes (restore intended behavior)
26
+ - Typos, formatting, comments
27
+ - Dependency updates (non-breaking)
28
+
29
+ ## Task Creation is MANDATORY Before Implementation
30
+
31
+ **ABSOLUTE RULE**: You MUST create a task BEFORE implementing ANY feature.
32
+
33
+ ### MANDATORY Workflow
34
+
35
+ **NEVER start implementation without creating a task first:**
36
+
37
+ ```bash
38
+ # WRONG: Starting implementation directly
39
+ # ... writing code without task ...
40
+
41
+ # CORRECT: Create task first
42
+ rulebook task create <task-id>
43
+ # Write proposal.md
44
+ # Write tasks.md
45
+ # Write spec deltas
46
+ rulebook task validate <task-id>
47
+ # NOW you can start implementation
48
+ ```
49
+
50
+ ### Task Creation Steps
51
+
52
+ **When a feature is requested:**
53
+
54
+ 1. **STOP** - Do not start coding
55
+ 2. **Create task** - `rulebook task create <task-id>`
56
+ 3. **Plan** - Write proposal.md and tasks.md
57
+ 4. **Spec** - Write spec deltas
58
+ 5. **Validate** - `rulebook task validate <task-id>`
59
+ 6. **THEN** - Start implementation
60
+
61
+ ## Task Directory Structure
62
+
63
+ ```
64
+ .rulebook/tasks/<task-id>/
65
+ ├── proposal.md # Why and what changes
66
+ ├── tasks.md # Implementation checklist
67
+ ├── design.md # Technical design (optional)
68
+ └── specs/
69
+ └── <module>/
70
+ └── spec.md # Technical specifications
71
+ ```
72
+
73
+ ## Task Commands
74
+
75
+ ```bash
76
+ # Create new task
77
+ rulebook task create <task-id>
78
+
79
+ # List all tasks
80
+ rulebook task list
81
+
82
+ # Show task details
83
+ rulebook task show <task-id>
84
+
85
+ # Validate task structure
86
+ rulebook task validate <task-id>
87
+
88
+ # Archive completed task
89
+ rulebook task archive <task-id>
90
+ ```
91
+
92
+ ## Proposal Format (proposal.md)
93
+
94
+ ```markdown
95
+ # Proposal: <Task Title>
96
+
97
+ ## Why
98
+ <Explain the problem or opportunity>
99
+
100
+ ## What Changes
101
+ <List of changes with ADDED/MODIFIED/REMOVED markers>
102
+
103
+ ## Impact
104
+ - Affected specs: <list spec files>
105
+ - Affected code: <list source files>
106
+ - Breaking change: YES/NO
107
+ - User benefit: <describe benefit>
108
+ ```
109
+
110
+ ## Tasks Format (tasks.md)
111
+
112
+ **CRITICAL**: Only simple checklist items. Technical details go in specs.
113
+
114
+ ```markdown
115
+ ## 1. <Phase Name>
116
+ - [ ] 1.1 <Simple task description>
117
+ - [ ] 1.2 <Simple task description>
118
+
119
+ ## 2. <Phase Name>
120
+ - [ ] 2.1 <Simple task description>
121
+ ```
122
+
123
+ ## Spec Delta Format (specs/<module>/spec.md)
124
+
125
+ ```markdown
126
+ # <Module> Specification
127
+
128
+ ## ADDED Requirements
129
+
130
+ ### Requirement: <Name>
131
+ <Description>
132
+
133
+ #### Scenario: <Name>
134
+ Given <context>
135
+ When <action>
136
+ Then <expected result>
137
+
138
+ ## MODIFIED Requirements
139
+
140
+ ### Requirement: <Original Name>
141
+ <Description of modification>
142
+
143
+ ## REMOVED Requirements
144
+
145
+ ### Requirement: <Name to Remove>
146
+ <Reason for removal>
147
+ ```
148
+
149
+ ## MCP Integration
150
+
151
+ If MCP server is enabled, use programmatic task management:
152
+
153
+ ```typescript
154
+ // Create task
155
+ await mcp.rulebook_task_create({ taskId: "my-task" });
156
+
157
+ // List tasks
158
+ await mcp.rulebook_task_list({});
159
+
160
+ // Show task
161
+ await mcp.rulebook_task_show({ taskId: "my-task" });
162
+
163
+ // Validate task
164
+ await mcp.rulebook_task_validate({ taskId: "my-task" });
165
+
166
+ // Archive task
167
+ await mcp.rulebook_task_archive({ taskId: "my-task" });
168
+ ```
169
+
170
+ ## Best Practices
171
+
172
+ 1. **Always create task first** - Never implement without documentation
173
+ 2. **Keep tasks.md simple** - Only checklist items, no explanations
174
+ 3. **Put details in specs** - Technical requirements go in spec files
175
+ 4. **Validate before implementing** - Run `rulebook task validate`
176
+ 5. **Archive when done** - Move completed tasks to archive