@hivehub/rulebook 5.1.3 → 5.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 (374) 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-decision-create.md +55 -55
  9. package/.claude/commands/rulebook-decision-list.md +15 -15
  10. package/.claude/commands/rulebook-knowledge-add.md +41 -41
  11. package/.claude/commands/rulebook-knowledge-list.md +15 -15
  12. package/.claude/commands/rulebook-learn-capture.md +48 -48
  13. package/.claude/commands/rulebook-learn-list.md +13 -13
  14. package/.claude/commands/rulebook-memory-save.md +48 -48
  15. package/.claude/commands/rulebook-memory-search.md +47 -47
  16. package/.claude/commands/rulebook-task-apply.md +85 -67
  17. package/.claude/commands/rulebook-task-archive.md +103 -94
  18. package/.claude/commands/rulebook-task-create.md +93 -93
  19. package/.claude/commands/rulebook-task-list.md +42 -42
  20. package/.claude/commands/rulebook-task-show.md +52 -52
  21. package/.claude/commands/rulebook-task-validate.md +53 -53
  22. package/.claude-plugin/marketplace.json +28 -28
  23. package/.claude-plugin/plugin.json +8 -8
  24. package/README.md +25 -43
  25. package/dist/cli/commands.d.ts.map +1 -1
  26. package/dist/cli/commands.js +11 -0
  27. package/dist/cli/commands.js.map +1 -1
  28. package/dist/core/agent-template-engine.js +28 -28
  29. package/dist/core/generator.js +28 -28
  30. package/dist/core/task-manager.d.ts +23 -0
  31. package/dist/core/task-manager.d.ts.map +1 -1
  32. package/dist/core/task-manager.js +163 -27
  33. package/dist/core/task-manager.js.map +1 -1
  34. package/dist/index.js +0 -0
  35. package/dist/mcp/rulebook-server.js +3 -3
  36. package/dist/mcp/rulebook-server.js.map +1 -1
  37. package/dist/memory/memory-store.js +91 -91
  38. package/package.json +21 -22
  39. package/templates/agents/accessibility-reviewer.md +43 -43
  40. package/templates/agents/api-designer.md +42 -42
  41. package/templates/agents/architect.md +51 -51
  42. package/templates/agents/build-engineer.md +36 -36
  43. package/templates/agents/code-reviewer.md +47 -47
  44. package/templates/agents/compiler/codegen-debugger.md +34 -34
  45. package/templates/agents/compiler/stdlib-engineer.md +28 -28
  46. package/templates/agents/compiler/test-coverage-guardian.md +31 -31
  47. package/templates/agents/context-intelligence.md +52 -52
  48. package/templates/agents/database-architect.md +41 -41
  49. package/templates/agents/devops-engineer.md +42 -42
  50. package/templates/agents/docs-writer.md +38 -38
  51. package/templates/agents/game-engine/cpp-core-expert.md +35 -35
  52. package/templates/agents/game-engine/render-engineer.md +22 -22
  53. package/templates/agents/game-engine/shader-engineer.md +38 -38
  54. package/templates/agents/game-engine/systems-integration.md +43 -43
  55. package/templates/agents/generic/code-reviewer.md +41 -41
  56. package/templates/agents/generic/docs-writer.md +25 -25
  57. package/templates/agents/generic/project-manager.md +36 -36
  58. package/templates/agents/generic/researcher.md +34 -34
  59. package/templates/agents/generic/test-engineer.md +41 -41
  60. package/templates/agents/i18n-engineer.md +42 -42
  61. package/templates/agents/implementer.md +42 -42
  62. package/templates/agents/migration-engineer.md +42 -42
  63. package/templates/agents/mobile/platform-specialist.md +22 -22
  64. package/templates/agents/mobile/ui-engineer.md +22 -22
  65. package/templates/agents/performance-engineer.md +49 -49
  66. package/templates/agents/refactoring-agent.md +41 -41
  67. package/templates/agents/researcher.md +38 -38
  68. package/templates/agents/security-reviewer.md +40 -40
  69. package/templates/agents/team-lead.md +37 -37
  70. package/templates/agents/tester.md +48 -48
  71. package/templates/agents/ux-reviewer.md +43 -43
  72. package/templates/agents/web-app/api-designer.md +22 -22
  73. package/templates/agents/web-app/backend-engineer.md +30 -30
  74. package/templates/agents/web-app/database-engineer.md +22 -22
  75. package/templates/agents/web-app/frontend-engineer.md +29 -29
  76. package/templates/agents/web-app/security-reviewer.md +32 -32
  77. package/templates/ci/rulebook-review.yml +26 -26
  78. package/templates/cli/AIDER.md +49 -49
  79. package/templates/cli/AMAZON_Q.md +25 -25
  80. package/templates/cli/AUGGIE.md +32 -32
  81. package/templates/cli/CLAUDE.md +117 -117
  82. package/templates/cli/CLINE.md +99 -99
  83. package/templates/cli/CODEBUDDY.md +20 -20
  84. package/templates/cli/CODEIUM.md +20 -20
  85. package/templates/cli/CODEX.md +21 -21
  86. package/templates/cli/CONTINUE.md +34 -34
  87. package/templates/cli/CURSOR_CLI.md +62 -62
  88. package/templates/cli/FACTORY.md +18 -18
  89. package/templates/cli/GEMINI.md +35 -35
  90. package/templates/cli/KILOCODE.md +18 -18
  91. package/templates/cli/OPENCODE.md +18 -18
  92. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  93. package/templates/commands/rulebook-decision-create.md +55 -55
  94. package/templates/commands/rulebook-decision-list.md +15 -15
  95. package/templates/commands/rulebook-knowledge-add.md +41 -41
  96. package/templates/commands/rulebook-knowledge-list.md +15 -15
  97. package/templates/commands/rulebook-learn-capture.md +48 -48
  98. package/templates/commands/rulebook-learn-list.md +13 -13
  99. package/templates/commands/rulebook-memory-save.md +48 -48
  100. package/templates/commands/rulebook-memory-search.md +47 -47
  101. package/templates/commands/rulebook-task-apply.md +67 -67
  102. package/templates/commands/rulebook-task-archive.md +94 -94
  103. package/templates/commands/rulebook-task-create.md +93 -93
  104. package/templates/commands/rulebook-task-list.md +42 -42
  105. package/templates/commands/rulebook-task-show.md +52 -52
  106. package/templates/commands/rulebook-task-validate.md +53 -53
  107. package/templates/core/AGENTS_LEAN.md +25 -25
  108. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  109. package/templates/core/AGENT_AUTOMATION.md +296 -296
  110. package/templates/core/DAG.md +304 -304
  111. package/templates/core/DECISIONS.md +38 -38
  112. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  113. package/templates/core/KNOWLEDGE.md +49 -49
  114. package/templates/core/MULTI_AGENT.md +74 -74
  115. package/templates/core/PLANS.md +28 -28
  116. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  117. package/templates/core/RALPH.md +471 -471
  118. package/templates/core/RULEBOOK.md +1947 -1947
  119. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  120. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  121. package/templates/frameworks/ANGULAR.md +36 -36
  122. package/templates/frameworks/DJANGO.md +83 -83
  123. package/templates/frameworks/ELECTRON.md +147 -147
  124. package/templates/frameworks/FLASK.md +38 -38
  125. package/templates/frameworks/FLUTTER.md +55 -55
  126. package/templates/frameworks/JQUERY.md +32 -32
  127. package/templates/frameworks/LARAVEL.md +38 -38
  128. package/templates/frameworks/NESTJS.md +43 -43
  129. package/templates/frameworks/NEXTJS.md +127 -127
  130. package/templates/frameworks/NUXT.md +40 -40
  131. package/templates/frameworks/RAILS.md +66 -66
  132. package/templates/frameworks/REACT.md +38 -38
  133. package/templates/frameworks/REACT_NATIVE.md +47 -47
  134. package/templates/frameworks/SPRING.md +39 -39
  135. package/templates/frameworks/SYMFONY.md +36 -36
  136. package/templates/frameworks/VUE.md +36 -36
  137. package/templates/frameworks/ZEND.md +35 -35
  138. package/templates/git/CI_CD_PATTERNS.md +661 -661
  139. package/templates/git/GITHUB_ACTIONS.md +728 -728
  140. package/templates/git/GITLAB_CI.md +730 -730
  141. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  142. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  143. package/templates/hooks/COMMIT_MSG.md +530 -530
  144. package/templates/hooks/POST_CHECKOUT.md +546 -546
  145. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  146. package/templates/hooks/PRE_COMMIT.md +414 -414
  147. package/templates/hooks/PRE_PUSH.md +601 -601
  148. package/templates/ides/CONTINUE_RULES.md +16 -16
  149. package/templates/ides/COPILOT.md +37 -37
  150. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  151. package/templates/ides/CURSOR.md +43 -43
  152. package/templates/ides/GEMINI_RULES.md +17 -17
  153. package/templates/ides/JETBRAINS_AI.md +35 -35
  154. package/templates/ides/REPLIT.md +36 -36
  155. package/templates/ides/TABNINE.md +29 -29
  156. package/templates/ides/VSCODE.md +40 -40
  157. package/templates/ides/WINDSURF.md +36 -36
  158. package/templates/ides/WINDSURF_RULES.md +14 -14
  159. package/templates/ides/ZED.md +32 -32
  160. package/templates/ides/cursor-mdc/go.mdc +24 -24
  161. package/templates/ides/cursor-mdc/python.mdc +24 -24
  162. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  163. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  164. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  165. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  166. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  167. package/templates/languages/C.md +333 -333
  168. package/templates/languages/CPP.md +743 -743
  169. package/templates/languages/CSHARP.md +417 -417
  170. package/templates/languages/ELIXIR.md +454 -454
  171. package/templates/languages/ERLANG.md +361 -361
  172. package/templates/languages/GO.md +645 -645
  173. package/templates/languages/HASKELL.md +177 -177
  174. package/templates/languages/JAVA.md +607 -607
  175. package/templates/languages/JAVASCRIPT.md +631 -631
  176. package/templates/languages/JULIA.md +97 -97
  177. package/templates/languages/KOTLIN.md +511 -511
  178. package/templates/languages/LISP.md +100 -100
  179. package/templates/languages/LUA.md +74 -74
  180. package/templates/languages/OBJECTIVEC.md +90 -90
  181. package/templates/languages/PHP.md +416 -416
  182. package/templates/languages/PYTHON.md +682 -682
  183. package/templates/languages/RUBY.md +421 -421
  184. package/templates/languages/RUST.md +477 -477
  185. package/templates/languages/SAS.md +73 -73
  186. package/templates/languages/SCALA.md +348 -348
  187. package/templates/languages/SOLIDITY.md +580 -580
  188. package/templates/languages/SQL.md +137 -137
  189. package/templates/languages/SWIFT.md +466 -466
  190. package/templates/languages/TYPESCRIPT.md +591 -591
  191. package/templates/languages/ZIG.md +265 -265
  192. package/templates/modules/ATLASSIAN.md +255 -255
  193. package/templates/modules/CONTEXT7.md +54 -54
  194. package/templates/modules/FIGMA.md +267 -267
  195. package/templates/modules/GITHUB_MCP.md +64 -64
  196. package/templates/modules/GRAFANA.md +328 -328
  197. package/templates/modules/MEMORY.md +126 -126
  198. package/templates/modules/NOTION.md +247 -247
  199. package/templates/modules/PLAYWRIGHT.md +90 -90
  200. package/templates/modules/RULEBOOK_MCP.md +156 -156
  201. package/templates/modules/SERENA.md +337 -337
  202. package/templates/modules/SUPABASE.md +223 -223
  203. package/templates/modules/SYNAP.md +69 -69
  204. package/templates/modules/VECTORIZER.md +63 -63
  205. package/templates/modules/sequential-thinking.md +42 -42
  206. package/templates/ralph/ralph-history.bat +4 -4
  207. package/templates/ralph/ralph-history.sh +5 -5
  208. package/templates/ralph/ralph-init.bat +5 -5
  209. package/templates/ralph/ralph-init.sh +5 -5
  210. package/templates/ralph/ralph-pause.bat +5 -5
  211. package/templates/ralph/ralph-pause.sh +5 -5
  212. package/templates/ralph/ralph-run.bat +5 -5
  213. package/templates/ralph/ralph-run.sh +5 -5
  214. package/templates/ralph/ralph-status.bat +4 -4
  215. package/templates/ralph/ralph-status.sh +5 -5
  216. package/templates/rules/follow-task-sequence.md +36 -36
  217. package/templates/rules/git-safety.md +29 -29
  218. package/templates/rules/incremental-tests.md +29 -29
  219. package/templates/rules/knowledge-base-usage.md +41 -0
  220. package/templates/rules/no-deferred.md +31 -31
  221. package/templates/rules/no-shortcuts.md +30 -30
  222. package/templates/rules/research-first.md +30 -30
  223. package/templates/rules/sequential-editing.md +21 -21
  224. package/templates/rules/session-workflow.md +24 -24
  225. package/templates/rules/task-decomposition.md +32 -32
  226. package/templates/services/AZURE_BLOB.md +184 -184
  227. package/templates/services/CASSANDRA.md +239 -239
  228. package/templates/services/DATADOG.md +26 -26
  229. package/templates/services/DOCKER.md +124 -124
  230. package/templates/services/DOCKER_COMPOSE.md +168 -168
  231. package/templates/services/DYNAMODB.md +308 -308
  232. package/templates/services/ELASTICSEARCH.md +347 -347
  233. package/templates/services/GCS.md +178 -178
  234. package/templates/services/HELM.md +194 -194
  235. package/templates/services/INFLUXDB.md +265 -265
  236. package/templates/services/KAFKA.md +341 -341
  237. package/templates/services/KUBERNETES.md +208 -208
  238. package/templates/services/MARIADB.md +183 -183
  239. package/templates/services/MEMCACHED.md +242 -242
  240. package/templates/services/MINIO.md +201 -201
  241. package/templates/services/MONGODB.md +268 -268
  242. package/templates/services/MYSQL.md +358 -358
  243. package/templates/services/NEO4J.md +247 -247
  244. package/templates/services/OPENTELEMETRY.md +25 -25
  245. package/templates/services/ORACLE.md +290 -290
  246. package/templates/services/PINO.md +24 -24
  247. package/templates/services/POSTGRESQL.md +326 -326
  248. package/templates/services/PROMETHEUS.md +33 -33
  249. package/templates/services/RABBITMQ.md +286 -286
  250. package/templates/services/REDIS.md +292 -292
  251. package/templates/services/S3.md +298 -298
  252. package/templates/services/SENTRY.md +23 -23
  253. package/templates/services/SQLITE.md +294 -294
  254. package/templates/services/SQLSERVER.md +294 -294
  255. package/templates/services/WINSTON.md +30 -30
  256. package/templates/skills/cli/aider/SKILL.md +59 -59
  257. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  258. package/templates/skills/cli/auggie/SKILL.md +42 -42
  259. package/templates/skills/cli/claude/SKILL.md +42 -42
  260. package/templates/skills/cli/cline/SKILL.md +42 -42
  261. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  262. package/templates/skills/cli/codeium/SKILL.md +30 -30
  263. package/templates/skills/cli/codex/SKILL.md +31 -31
  264. package/templates/skills/cli/continue/SKILL.md +44 -44
  265. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  266. package/templates/skills/cli/factory/SKILL.md +28 -28
  267. package/templates/skills/cli/gemini/SKILL.md +45 -45
  268. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  269. package/templates/skills/cli/opencode/SKILL.md +28 -28
  270. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  271. package/templates/skills/core/dag/SKILL.md +314 -314
  272. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  273. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  274. package/templates/skills/core/rulebook/SKILL.md +176 -176
  275. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  276. package/templates/skills/dev/api-design/SKILL.md +15 -15
  277. package/templates/skills/dev/architect/SKILL.md +17 -17
  278. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  279. package/templates/skills/dev/db-design/SKILL.md +15 -15
  280. package/templates/skills/dev/debug/SKILL.md +16 -16
  281. package/templates/skills/dev/deploy/SKILL.md +17 -17
  282. package/templates/skills/dev/docs/SKILL.md +17 -17
  283. package/templates/skills/dev/migrate/SKILL.md +15 -15
  284. package/templates/skills/dev/perf/SKILL.md +17 -17
  285. package/templates/skills/dev/refactor/SKILL.md +17 -17
  286. package/templates/skills/dev/research/SKILL.md +14 -14
  287. package/templates/skills/dev/review/SKILL.md +18 -18
  288. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  289. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  290. package/templates/skills/frameworks/django/SKILL.md +93 -93
  291. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  292. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  293. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  294. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  295. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  296. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  297. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  298. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  299. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  300. package/templates/skills/frameworks/react/SKILL.md +48 -48
  301. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  302. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  303. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  304. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  305. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  306. package/templates/skills/ides/copilot/SKILL.md +47 -47
  307. package/templates/skills/ides/cursor/SKILL.md +53 -53
  308. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  309. package/templates/skills/ides/replit/SKILL.md +46 -46
  310. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  311. package/templates/skills/ides/vscode/SKILL.md +50 -50
  312. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  313. package/templates/skills/ides/zed/SKILL.md +42 -42
  314. package/templates/skills/languages/c/SKILL.md +343 -343
  315. package/templates/skills/languages/cpp/SKILL.md +753 -753
  316. package/templates/skills/languages/csharp/SKILL.md +427 -427
  317. package/templates/skills/languages/elixir/SKILL.md +464 -464
  318. package/templates/skills/languages/erlang/SKILL.md +371 -371
  319. package/templates/skills/languages/go/SKILL.md +655 -655
  320. package/templates/skills/languages/haskell/SKILL.md +187 -187
  321. package/templates/skills/languages/java/SKILL.md +617 -617
  322. package/templates/skills/languages/javascript/SKILL.md +641 -641
  323. package/templates/skills/languages/julia/SKILL.md +107 -107
  324. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  325. package/templates/skills/languages/lisp/SKILL.md +110 -110
  326. package/templates/skills/languages/lua/SKILL.md +84 -84
  327. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  328. package/templates/skills/languages/php/SKILL.md +426 -426
  329. package/templates/skills/languages/python/SKILL.md +692 -692
  330. package/templates/skills/languages/ruby/SKILL.md +431 -431
  331. package/templates/skills/languages/rust/SKILL.md +487 -487
  332. package/templates/skills/languages/sas/SKILL.md +83 -83
  333. package/templates/skills/languages/scala/SKILL.md +358 -358
  334. package/templates/skills/languages/solidity/SKILL.md +590 -590
  335. package/templates/skills/languages/sql/SKILL.md +147 -147
  336. package/templates/skills/languages/swift/SKILL.md +476 -476
  337. package/templates/skills/languages/typescript/SKILL.md +302 -302
  338. package/templates/skills/languages/zig/SKILL.md +275 -275
  339. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  340. package/templates/skills/modules/context7/SKILL.md +64 -64
  341. package/templates/skills/modules/figma/SKILL.md +277 -277
  342. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  343. package/templates/skills/modules/grafana/SKILL.md +338 -338
  344. package/templates/skills/modules/memory/SKILL.md +73 -73
  345. package/templates/skills/modules/notion/SKILL.md +257 -257
  346. package/templates/skills/modules/playwright/SKILL.md +100 -100
  347. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  348. package/templates/skills/modules/serena/SKILL.md +347 -347
  349. package/templates/skills/modules/supabase/SKILL.md +233 -233
  350. package/templates/skills/modules/synap/SKILL.md +79 -79
  351. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  352. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  353. package/templates/skills/services/cassandra/SKILL.md +249 -249
  354. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  355. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  356. package/templates/skills/services/gcs/SKILL.md +188 -188
  357. package/templates/skills/services/influxdb/SKILL.md +275 -275
  358. package/templates/skills/services/kafka/SKILL.md +351 -351
  359. package/templates/skills/services/mariadb/SKILL.md +193 -193
  360. package/templates/skills/services/memcached/SKILL.md +252 -252
  361. package/templates/skills/services/minio/SKILL.md +211 -211
  362. package/templates/skills/services/mongodb/SKILL.md +278 -278
  363. package/templates/skills/services/mysql/SKILL.md +368 -368
  364. package/templates/skills/services/neo4j/SKILL.md +257 -257
  365. package/templates/skills/services/oracle/SKILL.md +300 -300
  366. package/templates/skills/services/postgresql/SKILL.md +336 -336
  367. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  368. package/templates/skills/services/redis/SKILL.md +302 -302
  369. package/templates/skills/services/s3/SKILL.md +308 -308
  370. package/templates/skills/services/sqlite/SKILL.md +304 -304
  371. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  372. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  373. package/templates/skills/workflows/ralph/install.sh +87 -87
  374. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,477 +1,477 @@
1
- <!-- RUST:START -->
2
- # Rust Project Rules
3
-
4
- ## Agent Automation Commands
5
-
6
- **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
7
-
8
- ```bash
9
- # Complete quality check sequence:
10
- cargo fmt --all -- --check # Format check
11
- cargo clippy --workspace --all-targets --all-features -- -D warnings # Lint
12
- cargo test --workspace --all-features # All tests (100% pass)
13
- cargo build --release # Build verification
14
- cargo llvm-cov --all # Coverage (95%+ required)
15
-
16
- # Security audit:
17
- cargo audit # Vulnerability scan
18
- cargo outdated # Check outdated deps
19
- ```
20
-
21
- ## Rust Edition and Toolchain
22
-
23
- **CRITICAL**: Always use Rust Edition 2024 with nightly toolchain.
24
-
25
- - **Edition**: 2024
26
- - **Toolchain**: nightly 1.85+
27
- - **Update**: Run `rustup update nightly` regularly
28
-
29
- ### Formatting
30
-
31
- - Use `rustfmt` with nightly toolchain
32
- - Configuration in `rustfmt.toml` or `.rustfmt.toml`
33
- - Always format before committing: `cargo +nightly fmt --all`
34
- - CI must check formatting: `cargo +nightly fmt --all -- --check`
35
-
36
- ### Linting
37
-
38
- - Use `clippy` with `-D warnings` (warnings as errors)
39
- - Fix all clippy warnings before committing
40
- - Acceptable exceptions must be documented with `#[allow(clippy::...)]` and justification
41
- - CI must enforce clippy: `cargo clippy --workspace -- -D warnings`
42
-
43
- ### Testing
44
-
45
- - **Location**: Tests in `/tests` directory for integration tests
46
- - **Unit Tests**: In same file as implementation with `#[cfg(test)]`
47
- - **Coverage**: Must meet project threshold (default 95%)
48
- - **Tools**: Use `cargo-nextest` for faster test execution
49
- - **Async**: Use `tokio::test` for async tests with Tokio runtime
50
-
51
- Example test structure:
52
- ```rust
53
- #[cfg(test)]
54
- mod tests {
55
- use super::*;
56
-
57
- #[test]
58
- fn test_feature() {
59
- // Test implementation
60
- }
61
-
62
- #[tokio::test]
63
- async fn test_async_feature() {
64
- // Async test implementation
65
- }
66
- }
67
- ```
68
-
69
- ### Test Categories: S2S and Slow Tests
70
-
71
- **CRITICAL**: Tests must be categorized based on execution time and dependencies.
72
-
73
- #### Test Time Limits
74
-
75
- - **Fast Tests**: Must complete in ≤ 10-20 seconds
76
- - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
77
- - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
78
-
79
- #### S2S (Server-to-Server) Tests
80
-
81
- **Tests that require active servers, databases, or external services must be isolated using Cargo features.**
82
-
83
- **Implementation**:
84
-
85
- 1. **Create `s2s` feature in `Cargo.toml`**:
86
- ```toml
87
- [features]
88
- default = []
89
- s2s = [] # Enable server-to-server tests
90
- ```
91
-
92
- 2. **Mark S2S tests with feature flag**:
93
- ```rust
94
- #[cfg(test)]
95
- mod tests {
96
- use super::*;
97
-
98
- // Regular fast test (always runs)
99
- #[test]
100
- fn test_local_computation() {
101
- // Fast test, no external dependencies
102
- }
103
-
104
- // S2S test (only runs with --features s2s)
105
- #[cfg(feature = "s2s")]
106
- #[tokio::test]
107
- async fn test_database_connection() {
108
- // Requires active database server
109
- let db = connect_to_database().await?;
110
- // ... test implementation
111
- }
112
-
113
- #[cfg(feature = "s2s")]
114
- #[tokio::test]
115
- async fn test_api_integration() {
116
- // Requires active API server
117
- let client = create_api_client().await?;
118
- // ... test implementation
119
- }
120
- }
121
- ```
122
-
123
- 3. **Run tests**:
124
- ```bash
125
- # Regular tests (excludes S2S)
126
- cargo test
127
-
128
- # Include S2S tests (requires active servers)
129
- cargo test --features s2s
130
-
131
- # CI/CD: Run S2S tests only when servers are available
132
- cargo test --features s2s --test-args '--test-threads=1'
133
- ```
134
-
135
- #### Slow Tests
136
-
137
- **Tests that take > 10-20 seconds must be marked and run separately.**
138
-
139
- **Implementation**:
140
-
141
- 1. **Create `slow` feature in `Cargo.toml`**:
142
- ```toml
143
- [features]
144
- default = []
145
- slow = [] # Enable slow tests
146
- ```
147
-
148
- 2. **Mark slow tests**:
149
- ```rust
150
- #[cfg(test)]
151
- mod tests {
152
- use super::*;
153
-
154
- // Fast test (always runs)
155
- #[test]
156
- fn test_quick_operation() {
157
- // Completes in < 1 second
158
- }
159
-
160
- // Slow test (only runs with --features slow)
161
- #[cfg(feature = "slow")]
162
- #[test]
163
- fn test_heavy_computation() {
164
- // Takes 30+ seconds
165
- // Heavy processing, large dataset, etc.
166
- }
167
-
168
- #[cfg(feature = "slow")]
169
- #[tokio::test]
170
- async fn test_large_file_processing() {
171
- // Processes large files, takes > 20 seconds
172
- }
173
- }
174
- ```
175
-
176
- 3. **Run tests**:
177
- ```bash
178
- # Regular tests (excludes slow)
179
- cargo test
180
-
181
- # Include slow tests
182
- cargo test --features slow
183
-
184
- # Run both S2S and slow tests
185
- cargo test --features s2s,slow
186
- ```
187
-
188
- #### Best Practices
189
-
190
- - ✅ **Always run fast tests** in CI/CD by default
191
- - ✅ **Isolate S2S tests** - never run them in standard test suite
192
- - ✅ **Mark slow tests** - prevent CI/CD timeouts
193
- - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
194
- - ✅ **Use timeouts** - Set appropriate timeouts for S2S tests: `tokio::time::timeout(Duration::from_secs(30), test_fn).await?`
195
- - ❌ **Never mix** fast and slow/S2S tests in same test run
196
- - ❌ **Never require** external services for standard test suite
197
- - ❌ **Never exceed** 10-20 seconds for regular tests
198
-
199
- ## Async Programming
200
-
201
- **CRITICAL**: Follow Tokio best practices for async code.
202
-
203
- - **Runtime**: Use Tokio for async runtime
204
- - **Blocking**: Never block in async context - use `spawn_blocking` for CPU-intensive tasks
205
- - **Channels**: Use `tokio::sync::mpsc` or `tokio::sync::broadcast` for async communication
206
- - **Timeouts**: Always set timeouts for network operations: `tokio::time::timeout`
207
-
208
- Example:
209
- ```rust
210
- use tokio::time::{timeout, Duration};
211
-
212
- async fn fetch_data() -> Result<Data, Error> {
213
- timeout(Duration::from_secs(30), async {
214
- // Network operation
215
- }).await?
216
- }
217
- ```
218
-
219
- ## Dependency Management
220
-
221
- **CRITICAL**: Always verify latest versions before adding dependencies.
222
-
223
- ### Before Adding Any Dependency
224
-
225
- 1. **Check Context7 for latest version**:
226
- - Use MCP Context7 tool if available
227
- - Search for the crate documentation
228
- - Verify the latest stable version
229
- - Review breaking changes and migration guides
230
-
231
- 2. **Example Workflow**:
232
- ```
233
- Adding tokio → Check crates.io and docs.rs
234
- Adding serde → Verify latest version with security updates
235
- Adding axum → Check for breaking changes in latest version
236
- ```
237
-
238
- 3. **Document Version Choice**:
239
- - Note why specific version chosen in `Cargo.toml` comments
240
- - Document any compatibility constraints
241
- - Update CHANGELOG.md with new dependencies
242
-
243
- ### Dependency Guidelines
244
-
245
- - ✅ Use latest stable versions
246
- - ✅ Check for security advisories: `cargo audit`
247
- - ✅ Prefer well-maintained crates (active development, good documentation)
248
- - ✅ Minimize dependency count
249
- - ✅ Use workspace dependencies for monorepos
250
- - ❌ Don't use outdated versions without justification
251
- - ❌ Don't add dependencies without checking latest version
252
-
253
- ## Codespell Configuration
254
-
255
- **CRITICAL**: Use codespell to catch typos in code and documentation.
256
-
257
- Install: `pip install 'codespell[toml]'`
258
-
259
- Configuration in `pyproject.toml`:
260
- ```toml
261
- [tool.codespell]
262
- skip = "*.lock,*.json,target,node_modules,.git"
263
- ignore-words-list = "crate,ser,deser"
264
- ```
265
-
266
- Or run with flags:
267
- ```bash
268
- codespell \
269
- --skip="*.lock,*.json,target,node_modules,.git" \
270
- --ignore-words-list="crate,ser,deser"
271
- ```
272
-
273
- ## Error Handling
274
-
275
- - Use `Result<T, E>` for recoverable errors
276
- - Use `thiserror` for custom error types
277
- - Use `anyhow` for application-level error handling
278
- - Document error conditions in function docs
279
- - Never use `unwrap()` or `expect()` in production code without justification
280
-
281
- Example:
282
- ```rust
283
- use thiserror::Error;
284
-
285
- #[derive(Error, Debug)]
286
- pub enum MyError {
287
- #[error("IO error: {0}")]
288
- Io(#[from] std::io::Error),
289
-
290
- #[error("Invalid input: {0}")]
291
- InvalidInput(String),
292
- }
293
-
294
- pub fn process_data(input: &str) -> Result<Data, MyError> {
295
- // Implementation
296
- }
297
- ```
298
-
299
- ## Documentation
300
-
301
- - **Public APIs**: Must have doc comments (`///`)
302
- - **Examples**: Include examples in doc comments
303
- - **Modules**: Document module purpose with `//!`
304
- - **Unsafe**: Always document safety requirements for `unsafe` code
305
- - **Run doctests**: `cargo test --doc`
306
-
307
- Example:
308
- ```rust
309
- /// Processes the input data and returns a result.
310
- ///
311
- /// # Arguments
312
- ///
313
- /// * `input` - The input string to process
314
- ///
315
- /// # Examples
316
- ///
317
- /// ```
318
- /// use mylib::process;
319
- /// let result = process("hello");
320
- /// assert_eq!(result, "HELLO");
321
- /// ```
322
- ///
323
- /// # Errors
324
- ///
325
- /// Returns `MyError::InvalidInput` if input is empty.
326
- pub fn process(input: &str) -> Result<String, MyError> {
327
- // Implementation
328
- }
329
- ```
330
-
331
- ## Project Structure
332
-
333
- ```
334
- project/
335
- ├── Cargo.toml # Package manifest
336
- ├── Cargo.lock # Dependency lock file (commit this)
337
- ├── README.md # Project overview (allowed in root)
338
- ├── CHANGELOG.md # Version history (allowed in root)
339
- ├── AGENTS.md # AI assistant rules (allowed in root)
340
- ├── LICENSE # Project license (allowed in root)
341
- ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
342
- ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
343
- ├── SECURITY.md # Security policy (allowed in root)
344
- ├── src/
345
- │ ├── lib.rs # Library root (for libraries)
346
- │ ├── main.rs # Binary root (for applications)
347
- │ └── ...
348
- ├── tests/ # Integration tests
349
- ├── examples/ # Example code
350
- ├── benches/ # Benchmarks
351
- └── docs/ # Project documentation
352
- ```
353
-
354
- ## CI/CD Requirements
355
-
356
- Must include GitHub Actions workflows for:
357
-
358
- 1. **Testing** (`rust-test.yml`):
359
- - Test on ubuntu-latest, windows-latest, macos-latest
360
- - Use `cargo-nextest` for fast test execution
361
- - Upload test results
362
-
363
- 2. **Linting** (`rust-lint.yml`):
364
- - Format check: `cargo +nightly fmt --all -- --check`
365
- - Clippy: `cargo clippy --workspace -- -D warnings`
366
- - All targets: `cargo clippy --workspace --all-targets -- -D warnings`
367
-
368
- 3. **Codespell** (`codespell.yml`):
369
- - Check for typos in code and documentation
370
- - Fail on errors
371
-
372
- ## Crate Publication
373
-
374
- ### Publishing to crates.io
375
-
376
- **Prerequisites:**
377
- 1. Create account at https://crates.io
378
- 2. Generate API token: `cargo login`
379
- 3. Add `CARGO_TOKEN` to GitHub repository secrets
380
-
381
- **Cargo.toml Configuration:**
382
-
383
- ```toml
384
- [package]
385
- name = "your-crate-name"
386
- version = "1.0.0"
387
- edition = "2024"
388
- authors = ["Your Name <your.email@example.com>"]
389
- license = "MIT OR Apache-2.0"
390
- description = "A short description of your crate"
391
- documentation = "https://docs.rs/your-crate-name"
392
- homepage = "https://github.com/your-org/your-crate-name"
393
- repository = "https://github.com/your-org/your-crate-name"
394
- readme = "README.md"
395
- keywords = ["your", "keywords", "here"]
396
- categories = ["category"]
397
- exclude = [
398
- ".github/",
399
- "tests/",
400
- "benches/",
401
- "examples/",
402
- "*.sh",
403
- ]
404
-
405
- [package.metadata.docs.rs]
406
- all-features = true
407
- rustdoc-args = ["--cfg", "docsrs"]
408
- ```
409
-
410
- **Publishing Workflow:**
411
-
412
- 1. Update version in Cargo.toml
413
- 2. Update CHANGELOG.md
414
- 3. Run quality checks:
415
- ```bash
416
- cargo fmt --all
417
- cargo clippy --workspace --all-targets -- -D warnings
418
- cargo test --all-features
419
- cargo doc --no-deps --all-features
420
- ```
421
- 4. Create git tag: `git tag v1.0.0 && git push --tags`
422
- 5. GitHub Actions automatically publishes to crates.io
423
- 6. Or manual publish: `cargo publish`
424
-
425
- **Publishing Checklist:**
426
-
427
- - ✅ All tests passing (`cargo test --all-features`)
428
- - ✅ No clippy warnings (`cargo clippy -- -D warnings`)
429
- - ✅ Code formatted (`cargo fmt --all -- --check`)
430
- - ✅ Documentation builds (`cargo doc --no-deps`)
431
- - ✅ Version updated in Cargo.toml
432
- - ✅ CHANGELOG.md updated
433
- - ✅ README.md up to date
434
- - ✅ LICENSE file present
435
- - ✅ Package size < 10MB (check with `cargo package --list`)
436
- - ✅ Verify with `cargo publish --dry-run`
437
-
438
- **Semantic Versioning:**
439
-
440
- Follow [SemVer](https://semver.org/) strictly:
441
- - **MAJOR**: Breaking API changes
442
- - **MINOR**: New features (backwards compatible)
443
- - **PATCH**: Bug fixes (backwards compatible)
444
-
445
- **Documentation:**
446
-
447
- - Use `///` for public API documentation
448
- - Include examples in doc comments
449
- - Use `#![deny(missing_docs)]` for libraries
450
- - Test documentation examples with `cargo test --doc`
451
-
452
- ```rust
453
- /// Processes the input data and returns a result.
454
- ///
455
- /// # Arguments
456
- ///
457
- /// * `input` - The input string to process
458
- ///
459
- /// # Examples
460
- ///
461
- /// ```
462
- /// use your_crate::process;
463
- ///
464
- /// let result = process("hello");
465
- /// assert_eq!(result, "HELLO");
466
- /// ```
467
- ///
468
- /// # Errors
469
- ///
470
- /// Returns an error if the input is empty.
471
- pub fn process(input: &str) -> Result<String, Error> {
472
- // Implementation
473
- }
474
- ```
475
-
476
- <!-- RUST:END -->
477
-
1
+ <!-- RUST:START -->
2
+ # Rust Project Rules
3
+
4
+ ## Agent Automation Commands
5
+
6
+ **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
7
+
8
+ ```bash
9
+ # Complete quality check sequence:
10
+ cargo fmt --all -- --check # Format check
11
+ cargo clippy --workspace --all-targets --all-features -- -D warnings # Lint
12
+ cargo test --workspace --all-features # All tests (100% pass)
13
+ cargo build --release # Build verification
14
+ cargo llvm-cov --all # Coverage (95%+ required)
15
+
16
+ # Security audit:
17
+ cargo audit # Vulnerability scan
18
+ cargo outdated # Check outdated deps
19
+ ```
20
+
21
+ ## Rust Edition and Toolchain
22
+
23
+ **CRITICAL**: Always use Rust Edition 2024 with nightly toolchain.
24
+
25
+ - **Edition**: 2024
26
+ - **Toolchain**: nightly 1.85+
27
+ - **Update**: Run `rustup update nightly` regularly
28
+
29
+ ### Formatting
30
+
31
+ - Use `rustfmt` with nightly toolchain
32
+ - Configuration in `rustfmt.toml` or `.rustfmt.toml`
33
+ - Always format before committing: `cargo +nightly fmt --all`
34
+ - CI must check formatting: `cargo +nightly fmt --all -- --check`
35
+
36
+ ### Linting
37
+
38
+ - Use `clippy` with `-D warnings` (warnings as errors)
39
+ - Fix all clippy warnings before committing
40
+ - Acceptable exceptions must be documented with `#[allow(clippy::...)]` and justification
41
+ - CI must enforce clippy: `cargo clippy --workspace -- -D warnings`
42
+
43
+ ### Testing
44
+
45
+ - **Location**: Tests in `/tests` directory for integration tests
46
+ - **Unit Tests**: In same file as implementation with `#[cfg(test)]`
47
+ - **Coverage**: Must meet project threshold (default 95%)
48
+ - **Tools**: Use `cargo-nextest` for faster test execution
49
+ - **Async**: Use `tokio::test` for async tests with Tokio runtime
50
+
51
+ Example test structure:
52
+ ```rust
53
+ #[cfg(test)]
54
+ mod tests {
55
+ use super::*;
56
+
57
+ #[test]
58
+ fn test_feature() {
59
+ // Test implementation
60
+ }
61
+
62
+ #[tokio::test]
63
+ async fn test_async_feature() {
64
+ // Async test implementation
65
+ }
66
+ }
67
+ ```
68
+
69
+ ### Test Categories: S2S and Slow Tests
70
+
71
+ **CRITICAL**: Tests must be categorized based on execution time and dependencies.
72
+
73
+ #### Test Time Limits
74
+
75
+ - **Fast Tests**: Must complete in ≤ 10-20 seconds
76
+ - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
77
+ - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
78
+
79
+ #### S2S (Server-to-Server) Tests
80
+
81
+ **Tests that require active servers, databases, or external services must be isolated using Cargo features.**
82
+
83
+ **Implementation**:
84
+
85
+ 1. **Create `s2s` feature in `Cargo.toml`**:
86
+ ```toml
87
+ [features]
88
+ default = []
89
+ s2s = [] # Enable server-to-server tests
90
+ ```
91
+
92
+ 2. **Mark S2S tests with feature flag**:
93
+ ```rust
94
+ #[cfg(test)]
95
+ mod tests {
96
+ use super::*;
97
+
98
+ // Regular fast test (always runs)
99
+ #[test]
100
+ fn test_local_computation() {
101
+ // Fast test, no external dependencies
102
+ }
103
+
104
+ // S2S test (only runs with --features s2s)
105
+ #[cfg(feature = "s2s")]
106
+ #[tokio::test]
107
+ async fn test_database_connection() {
108
+ // Requires active database server
109
+ let db = connect_to_database().await?;
110
+ // ... test implementation
111
+ }
112
+
113
+ #[cfg(feature = "s2s")]
114
+ #[tokio::test]
115
+ async fn test_api_integration() {
116
+ // Requires active API server
117
+ let client = create_api_client().await?;
118
+ // ... test implementation
119
+ }
120
+ }
121
+ ```
122
+
123
+ 3. **Run tests**:
124
+ ```bash
125
+ # Regular tests (excludes S2S)
126
+ cargo test
127
+
128
+ # Include S2S tests (requires active servers)
129
+ cargo test --features s2s
130
+
131
+ # CI/CD: Run S2S tests only when servers are available
132
+ cargo test --features s2s --test-args '--test-threads=1'
133
+ ```
134
+
135
+ #### Slow Tests
136
+
137
+ **Tests that take > 10-20 seconds must be marked and run separately.**
138
+
139
+ **Implementation**:
140
+
141
+ 1. **Create `slow` feature in `Cargo.toml`**:
142
+ ```toml
143
+ [features]
144
+ default = []
145
+ slow = [] # Enable slow tests
146
+ ```
147
+
148
+ 2. **Mark slow tests**:
149
+ ```rust
150
+ #[cfg(test)]
151
+ mod tests {
152
+ use super::*;
153
+
154
+ // Fast test (always runs)
155
+ #[test]
156
+ fn test_quick_operation() {
157
+ // Completes in < 1 second
158
+ }
159
+
160
+ // Slow test (only runs with --features slow)
161
+ #[cfg(feature = "slow")]
162
+ #[test]
163
+ fn test_heavy_computation() {
164
+ // Takes 30+ seconds
165
+ // Heavy processing, large dataset, etc.
166
+ }
167
+
168
+ #[cfg(feature = "slow")]
169
+ #[tokio::test]
170
+ async fn test_large_file_processing() {
171
+ // Processes large files, takes > 20 seconds
172
+ }
173
+ }
174
+ ```
175
+
176
+ 3. **Run tests**:
177
+ ```bash
178
+ # Regular tests (excludes slow)
179
+ cargo test
180
+
181
+ # Include slow tests
182
+ cargo test --features slow
183
+
184
+ # Run both S2S and slow tests
185
+ cargo test --features s2s,slow
186
+ ```
187
+
188
+ #### Best Practices
189
+
190
+ - ✅ **Always run fast tests** in CI/CD by default
191
+ - ✅ **Isolate S2S tests** - never run them in standard test suite
192
+ - ✅ **Mark slow tests** - prevent CI/CD timeouts
193
+ - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
194
+ - ✅ **Use timeouts** - Set appropriate timeouts for S2S tests: `tokio::time::timeout(Duration::from_secs(30), test_fn).await?`
195
+ - ❌ **Never mix** fast and slow/S2S tests in same test run
196
+ - ❌ **Never require** external services for standard test suite
197
+ - ❌ **Never exceed** 10-20 seconds for regular tests
198
+
199
+ ## Async Programming
200
+
201
+ **CRITICAL**: Follow Tokio best practices for async code.
202
+
203
+ - **Runtime**: Use Tokio for async runtime
204
+ - **Blocking**: Never block in async context - use `spawn_blocking` for CPU-intensive tasks
205
+ - **Channels**: Use `tokio::sync::mpsc` or `tokio::sync::broadcast` for async communication
206
+ - **Timeouts**: Always set timeouts for network operations: `tokio::time::timeout`
207
+
208
+ Example:
209
+ ```rust
210
+ use tokio::time::{timeout, Duration};
211
+
212
+ async fn fetch_data() -> Result<Data, Error> {
213
+ timeout(Duration::from_secs(30), async {
214
+ // Network operation
215
+ }).await?
216
+ }
217
+ ```
218
+
219
+ ## Dependency Management
220
+
221
+ **CRITICAL**: Always verify latest versions before adding dependencies.
222
+
223
+ ### Before Adding Any Dependency
224
+
225
+ 1. **Check Context7 for latest version**:
226
+ - Use MCP Context7 tool if available
227
+ - Search for the crate documentation
228
+ - Verify the latest stable version
229
+ - Review breaking changes and migration guides
230
+
231
+ 2. **Example Workflow**:
232
+ ```
233
+ Adding tokio → Check crates.io and docs.rs
234
+ Adding serde → Verify latest version with security updates
235
+ Adding axum → Check for breaking changes in latest version
236
+ ```
237
+
238
+ 3. **Document Version Choice**:
239
+ - Note why specific version chosen in `Cargo.toml` comments
240
+ - Document any compatibility constraints
241
+ - Update CHANGELOG.md with new dependencies
242
+
243
+ ### Dependency Guidelines
244
+
245
+ - ✅ Use latest stable versions
246
+ - ✅ Check for security advisories: `cargo audit`
247
+ - ✅ Prefer well-maintained crates (active development, good documentation)
248
+ - ✅ Minimize dependency count
249
+ - ✅ Use workspace dependencies for monorepos
250
+ - ❌ Don't use outdated versions without justification
251
+ - ❌ Don't add dependencies without checking latest version
252
+
253
+ ## Codespell Configuration
254
+
255
+ **CRITICAL**: Use codespell to catch typos in code and documentation.
256
+
257
+ Install: `pip install 'codespell[toml]'`
258
+
259
+ Configuration in `pyproject.toml`:
260
+ ```toml
261
+ [tool.codespell]
262
+ skip = "*.lock,*.json,target,node_modules,.git"
263
+ ignore-words-list = "crate,ser,deser"
264
+ ```
265
+
266
+ Or run with flags:
267
+ ```bash
268
+ codespell \
269
+ --skip="*.lock,*.json,target,node_modules,.git" \
270
+ --ignore-words-list="crate,ser,deser"
271
+ ```
272
+
273
+ ## Error Handling
274
+
275
+ - Use `Result<T, E>` for recoverable errors
276
+ - Use `thiserror` for custom error types
277
+ - Use `anyhow` for application-level error handling
278
+ - Document error conditions in function docs
279
+ - Never use `unwrap()` or `expect()` in production code without justification
280
+
281
+ Example:
282
+ ```rust
283
+ use thiserror::Error;
284
+
285
+ #[derive(Error, Debug)]
286
+ pub enum MyError {
287
+ #[error("IO error: {0}")]
288
+ Io(#[from] std::io::Error),
289
+
290
+ #[error("Invalid input: {0}")]
291
+ InvalidInput(String),
292
+ }
293
+
294
+ pub fn process_data(input: &str) -> Result<Data, MyError> {
295
+ // Implementation
296
+ }
297
+ ```
298
+
299
+ ## Documentation
300
+
301
+ - **Public APIs**: Must have doc comments (`///`)
302
+ - **Examples**: Include examples in doc comments
303
+ - **Modules**: Document module purpose with `//!`
304
+ - **Unsafe**: Always document safety requirements for `unsafe` code
305
+ - **Run doctests**: `cargo test --doc`
306
+
307
+ Example:
308
+ ```rust
309
+ /// Processes the input data and returns a result.
310
+ ///
311
+ /// # Arguments
312
+ ///
313
+ /// * `input` - The input string to process
314
+ ///
315
+ /// # Examples
316
+ ///
317
+ /// ```
318
+ /// use mylib::process;
319
+ /// let result = process("hello");
320
+ /// assert_eq!(result, "HELLO");
321
+ /// ```
322
+ ///
323
+ /// # Errors
324
+ ///
325
+ /// Returns `MyError::InvalidInput` if input is empty.
326
+ pub fn process(input: &str) -> Result<String, MyError> {
327
+ // Implementation
328
+ }
329
+ ```
330
+
331
+ ## Project Structure
332
+
333
+ ```
334
+ project/
335
+ ├── Cargo.toml # Package manifest
336
+ ├── Cargo.lock # Dependency lock file (commit this)
337
+ ├── README.md # Project overview (allowed in root)
338
+ ├── CHANGELOG.md # Version history (allowed in root)
339
+ ├── AGENTS.md # AI assistant rules (allowed in root)
340
+ ├── LICENSE # Project license (allowed in root)
341
+ ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
342
+ ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
343
+ ├── SECURITY.md # Security policy (allowed in root)
344
+ ├── src/
345
+ │ ├── lib.rs # Library root (for libraries)
346
+ │ ├── main.rs # Binary root (for applications)
347
+ │ └── ...
348
+ ├── tests/ # Integration tests
349
+ ├── examples/ # Example code
350
+ ├── benches/ # Benchmarks
351
+ └── docs/ # Project documentation
352
+ ```
353
+
354
+ ## CI/CD Requirements
355
+
356
+ Must include GitHub Actions workflows for:
357
+
358
+ 1. **Testing** (`rust-test.yml`):
359
+ - Test on ubuntu-latest, windows-latest, macos-latest
360
+ - Use `cargo-nextest` for fast test execution
361
+ - Upload test results
362
+
363
+ 2. **Linting** (`rust-lint.yml`):
364
+ - Format check: `cargo +nightly fmt --all -- --check`
365
+ - Clippy: `cargo clippy --workspace -- -D warnings`
366
+ - All targets: `cargo clippy --workspace --all-targets -- -D warnings`
367
+
368
+ 3. **Codespell** (`codespell.yml`):
369
+ - Check for typos in code and documentation
370
+ - Fail on errors
371
+
372
+ ## Crate Publication
373
+
374
+ ### Publishing to crates.io
375
+
376
+ **Prerequisites:**
377
+ 1. Create account at https://crates.io
378
+ 2. Generate API token: `cargo login`
379
+ 3. Add `CARGO_TOKEN` to GitHub repository secrets
380
+
381
+ **Cargo.toml Configuration:**
382
+
383
+ ```toml
384
+ [package]
385
+ name = "your-crate-name"
386
+ version = "1.0.0"
387
+ edition = "2024"
388
+ authors = ["Your Name <your.email@example.com>"]
389
+ license = "MIT OR Apache-2.0"
390
+ description = "A short description of your crate"
391
+ documentation = "https://docs.rs/your-crate-name"
392
+ homepage = "https://github.com/your-org/your-crate-name"
393
+ repository = "https://github.com/your-org/your-crate-name"
394
+ readme = "README.md"
395
+ keywords = ["your", "keywords", "here"]
396
+ categories = ["category"]
397
+ exclude = [
398
+ ".github/",
399
+ "tests/",
400
+ "benches/",
401
+ "examples/",
402
+ "*.sh",
403
+ ]
404
+
405
+ [package.metadata.docs.rs]
406
+ all-features = true
407
+ rustdoc-args = ["--cfg", "docsrs"]
408
+ ```
409
+
410
+ **Publishing Workflow:**
411
+
412
+ 1. Update version in Cargo.toml
413
+ 2. Update CHANGELOG.md
414
+ 3. Run quality checks:
415
+ ```bash
416
+ cargo fmt --all
417
+ cargo clippy --workspace --all-targets -- -D warnings
418
+ cargo test --all-features
419
+ cargo doc --no-deps --all-features
420
+ ```
421
+ 4. Create git tag: `git tag v1.0.0 && git push --tags`
422
+ 5. GitHub Actions automatically publishes to crates.io
423
+ 6. Or manual publish: `cargo publish`
424
+
425
+ **Publishing Checklist:**
426
+
427
+ - ✅ All tests passing (`cargo test --all-features`)
428
+ - ✅ No clippy warnings (`cargo clippy -- -D warnings`)
429
+ - ✅ Code formatted (`cargo fmt --all -- --check`)
430
+ - ✅ Documentation builds (`cargo doc --no-deps`)
431
+ - ✅ Version updated in Cargo.toml
432
+ - ✅ CHANGELOG.md updated
433
+ - ✅ README.md up to date
434
+ - ✅ LICENSE file present
435
+ - ✅ Package size < 10MB (check with `cargo package --list`)
436
+ - ✅ Verify with `cargo publish --dry-run`
437
+
438
+ **Semantic Versioning:**
439
+
440
+ Follow [SemVer](https://semver.org/) strictly:
441
+ - **MAJOR**: Breaking API changes
442
+ - **MINOR**: New features (backwards compatible)
443
+ - **PATCH**: Bug fixes (backwards compatible)
444
+
445
+ **Documentation:**
446
+
447
+ - Use `///` for public API documentation
448
+ - Include examples in doc comments
449
+ - Use `#![deny(missing_docs)]` for libraries
450
+ - Test documentation examples with `cargo test --doc`
451
+
452
+ ```rust
453
+ /// Processes the input data and returns a result.
454
+ ///
455
+ /// # Arguments
456
+ ///
457
+ /// * `input` - The input string to process
458
+ ///
459
+ /// # Examples
460
+ ///
461
+ /// ```
462
+ /// use your_crate::process;
463
+ ///
464
+ /// let result = process("hello");
465
+ /// assert_eq!(result, "HELLO");
466
+ /// ```
467
+ ///
468
+ /// # Errors
469
+ ///
470
+ /// Returns an error if the input is empty.
471
+ pub fn process(input: &str) -> Result<String, Error> {
472
+ // Implementation
473
+ }
474
+ ```
475
+
476
+ <!-- RUST:END -->
477
+