@hivehub/rulebook 5.4.0 → 5.4.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 (454) hide show
  1. package/.claude/commands/analysis.md +35 -35
  2. package/.claude/commands/continue.md +33 -33
  3. package/.claude/commands/ralph-config.md +112 -112
  4. package/.claude/commands/ralph-history.md +110 -110
  5. package/.claude/commands/ralph-init.md +72 -72
  6. package/.claude/commands/ralph-pause-resume.md +105 -105
  7. package/.claude/commands/ralph-run.md +101 -101
  8. package/.claude/commands/ralph-status.md +76 -76
  9. package/.claude/commands/rulebook-decision-create.md +55 -55
  10. package/.claude/commands/rulebook-decision-list.md +15 -15
  11. package/.claude/commands/rulebook-knowledge-add.md +41 -41
  12. package/.claude/commands/rulebook-knowledge-list.md +15 -15
  13. package/.claude/commands/rulebook-learn-capture.md +48 -48
  14. package/.claude/commands/rulebook-learn-list.md +13 -13
  15. package/.claude/commands/rulebook-memory-save.md +48 -48
  16. package/.claude/commands/rulebook-memory-search.md +47 -47
  17. package/.claude/commands/rulebook-task-apply.md +67 -67
  18. package/.claude/commands/rulebook-task-archive.md +94 -94
  19. package/.claude/commands/rulebook-task-create.md +93 -93
  20. package/.claude/commands/rulebook-task-list.md +42 -42
  21. package/.claude/commands/rulebook-task-show.md +52 -52
  22. package/.claude/commands/rulebook-task-validate.md +53 -53
  23. package/.claude-plugin/marketplace.json +28 -28
  24. package/.claude-plugin/plugin.json +8 -8
  25. package/LICENSE +191 -191
  26. package/README.md +393 -393
  27. package/dist/index.js +0 -0
  28. package/dist/mcp/rulebook-server.js +0 -0
  29. package/package.json +22 -21
  30. package/templates/agents/accessibility-reviewer.md +43 -43
  31. package/templates/agents/api-designer.md +42 -42
  32. package/templates/agents/architect.md +51 -51
  33. package/templates/agents/build-engineer.md +36 -36
  34. package/templates/agents/code-reviewer.md +47 -47
  35. package/templates/agents/compiler/codegen-debugger.md +34 -34
  36. package/templates/agents/compiler/stdlib-engineer.md +28 -28
  37. package/templates/agents/compiler/test-coverage-guardian.md +31 -31
  38. package/templates/agents/context-intelligence.md +52 -52
  39. package/templates/agents/database-architect.md +41 -41
  40. package/templates/agents/devops-engineer.md +42 -42
  41. package/templates/agents/docs-writer.md +38 -38
  42. package/templates/agents/game-engine/cpp-core-expert.md +35 -35
  43. package/templates/agents/game-engine/render-engineer.md +22 -22
  44. package/templates/agents/game-engine/shader-engineer.md +38 -38
  45. package/templates/agents/game-engine/systems-integration.md +43 -43
  46. package/templates/agents/generic/code-reviewer.md +41 -41
  47. package/templates/agents/generic/docs-writer.md +25 -25
  48. package/templates/agents/generic/project-manager.md +36 -36
  49. package/templates/agents/generic/researcher.md +34 -34
  50. package/templates/agents/generic/test-engineer.md +41 -41
  51. package/templates/agents/i18n-engineer.md +42 -42
  52. package/templates/agents/implementer.md +42 -42
  53. package/templates/agents/migration-engineer.md +42 -42
  54. package/templates/agents/mobile/platform-specialist.md +22 -22
  55. package/templates/agents/mobile/ui-engineer.md +22 -22
  56. package/templates/agents/performance-engineer.md +49 -49
  57. package/templates/agents/refactoring-agent.md +41 -41
  58. package/templates/agents/researcher.md +38 -38
  59. package/templates/agents/security-reviewer.md +40 -40
  60. package/templates/agents/team-lead.md +37 -37
  61. package/templates/agents/tester.md +48 -48
  62. package/templates/agents/ux-reviewer.md +43 -43
  63. package/templates/agents/web-app/api-designer.md +22 -22
  64. package/templates/agents/web-app/backend-engineer.md +30 -30
  65. package/templates/agents/web-app/database-engineer.md +22 -22
  66. package/templates/agents/web-app/frontend-engineer.md +29 -29
  67. package/templates/agents/web-app/security-reviewer.md +32 -32
  68. package/templates/ci/rulebook-review.yml +26 -26
  69. package/templates/cli/AIDER.md +49 -49
  70. package/templates/cli/AMAZON_Q.md +25 -25
  71. package/templates/cli/AUGGIE.md +32 -32
  72. package/templates/cli/CLAUDE.md +117 -117
  73. package/templates/cli/CLINE.md +99 -99
  74. package/templates/cli/CODEBUDDY.md +20 -20
  75. package/templates/cli/CODEIUM.md +20 -20
  76. package/templates/cli/CODEX.md +21 -21
  77. package/templates/cli/CONTINUE.md +34 -34
  78. package/templates/cli/CURSOR_CLI.md +62 -62
  79. package/templates/cli/FACTORY.md +18 -18
  80. package/templates/cli/GEMINI.md +35 -35
  81. package/templates/cli/KILOCODE.md +18 -18
  82. package/templates/cli/OPENCODE.md +18 -18
  83. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  84. package/templates/cli/gemini-extension.json +77 -77
  85. package/templates/commands/rulebook-decision-create.md +55 -55
  86. package/templates/commands/rulebook-decision-list.md +15 -15
  87. package/templates/commands/rulebook-knowledge-add.md +41 -41
  88. package/templates/commands/rulebook-knowledge-list.md +15 -15
  89. package/templates/commands/rulebook-learn-capture.md +48 -48
  90. package/templates/commands/rulebook-learn-list.md +13 -13
  91. package/templates/commands/rulebook-memory-save.md +48 -48
  92. package/templates/commands/rulebook-memory-search.md +47 -47
  93. package/templates/commands/rulebook-task-apply.md +67 -67
  94. package/templates/commands/rulebook-task-archive.md +94 -94
  95. package/templates/commands/rulebook-task-create.md +93 -93
  96. package/templates/commands/rulebook-task-list.md +42 -42
  97. package/templates/commands/rulebook-task-show.md +52 -52
  98. package/templates/commands/rulebook-task-validate.md +53 -53
  99. package/templates/compact-context/_default.md +23 -23
  100. package/templates/compact-context/cpp.md +26 -26
  101. package/templates/compact-context/go.md +26 -26
  102. package/templates/compact-context/python.md +26 -26
  103. package/templates/compact-context/rust.md +28 -28
  104. package/templates/compact-context/typescript.md +29 -29
  105. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  106. package/templates/core/AGENT_AUTOMATION.md +296 -296
  107. package/templates/core/CLAUDE_MD_v2.md +71 -71
  108. package/templates/core/DAG.md +304 -304
  109. package/templates/core/DECISIONS.md +38 -38
  110. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  111. package/templates/core/KNOWLEDGE.md +49 -49
  112. package/templates/core/MULTI_AGENT.md +74 -74
  113. package/templates/core/PLANS.md +28 -28
  114. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  115. package/templates/core/RALPH.md +471 -471
  116. package/templates/core/RULEBOOK.md +1947 -1947
  117. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  118. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  119. package/templates/core/WORKSPACE.md +69 -69
  120. package/templates/frameworks/ANGULAR.md +36 -36
  121. package/templates/frameworks/DJANGO.md +83 -83
  122. package/templates/frameworks/ELECTRON.md +147 -147
  123. package/templates/frameworks/FLASK.md +38 -38
  124. package/templates/frameworks/FLUTTER.md +55 -55
  125. package/templates/frameworks/JQUERY.md +32 -32
  126. package/templates/frameworks/LARAVEL.md +38 -38
  127. package/templates/frameworks/NESTJS.md +43 -43
  128. package/templates/frameworks/NEXTJS.md +127 -127
  129. package/templates/frameworks/NUXT.md +40 -40
  130. package/templates/frameworks/RAILS.md +66 -66
  131. package/templates/frameworks/REACT.md +38 -38
  132. package/templates/frameworks/REACT_NATIVE.md +47 -47
  133. package/templates/frameworks/SPRING.md +39 -39
  134. package/templates/frameworks/SYMFONY.md +36 -36
  135. package/templates/frameworks/VUE.md +36 -36
  136. package/templates/frameworks/ZEND.md +35 -35
  137. package/templates/git/CI_CD_PATTERNS.md +661 -661
  138. package/templates/git/GITHUB_ACTIONS.md +728 -728
  139. package/templates/git/GITLAB_CI.md +730 -730
  140. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  141. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  142. package/templates/hooks/COMMIT_MSG.md +530 -530
  143. package/templates/hooks/POST_CHECKOUT.md +546 -546
  144. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  145. package/templates/hooks/PRE_COMMIT.md +414 -414
  146. package/templates/hooks/PRE_PUSH.md +601 -601
  147. package/templates/hooks/check-context-and-handoff.ps1 +58 -58
  148. package/templates/hooks/check-context-and-handoff.sh +76 -76
  149. package/templates/hooks/enforce-team-for-background-agents.ps1 +63 -63
  150. package/templates/hooks/enforce-team-for-background-agents.sh +55 -55
  151. package/templates/hooks/on-compact-reinject.sh +34 -34
  152. package/templates/hooks/resume-from-handoff.ps1 +40 -40
  153. package/templates/hooks/resume-from-handoff.sh +61 -61
  154. package/templates/hooks/terse-activate.ps1 +143 -143
  155. package/templates/hooks/terse-activate.sh +197 -197
  156. package/templates/hooks/terse-mode-tracker.ps1 +153 -153
  157. package/templates/hooks/terse-mode-tracker.sh +187 -187
  158. package/templates/ides/CONTINUE_RULES.md +16 -16
  159. package/templates/ides/COPILOT.md +37 -37
  160. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  161. package/templates/ides/CURSOR.md +43 -43
  162. package/templates/ides/GEMINI_RULES.md +17 -17
  163. package/templates/ides/JETBRAINS_AI.md +35 -35
  164. package/templates/ides/REPLIT.md +36 -36
  165. package/templates/ides/TABNINE.md +29 -29
  166. package/templates/ides/VSCODE.md +40 -40
  167. package/templates/ides/WINDSURF.md +36 -36
  168. package/templates/ides/WINDSURF_RULES.md +14 -14
  169. package/templates/ides/ZED.md +32 -32
  170. package/templates/ides/cursor-mdc/go.mdc +24 -24
  171. package/templates/ides/cursor-mdc/python.mdc +24 -24
  172. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  173. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  174. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  175. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  176. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  177. package/templates/languages/C.md +333 -333
  178. package/templates/languages/CPP.md +743 -743
  179. package/templates/languages/CSHARP.md +417 -417
  180. package/templates/languages/ELIXIR.md +454 -454
  181. package/templates/languages/ERLANG.md +361 -361
  182. package/templates/languages/GO.md +645 -645
  183. package/templates/languages/HASKELL.md +177 -177
  184. package/templates/languages/JAVA.md +607 -607
  185. package/templates/languages/JAVASCRIPT.md +631 -631
  186. package/templates/languages/JULIA.md +97 -97
  187. package/templates/languages/KOTLIN.md +511 -511
  188. package/templates/languages/LISP.md +100 -100
  189. package/templates/languages/LUA.md +74 -74
  190. package/templates/languages/OBJECTIVEC.md +90 -90
  191. package/templates/languages/PHP.md +416 -416
  192. package/templates/languages/PYTHON.md +682 -682
  193. package/templates/languages/RUBY.md +421 -421
  194. package/templates/languages/RUST.md +477 -477
  195. package/templates/languages/SAS.md +73 -73
  196. package/templates/languages/SCALA.md +348 -348
  197. package/templates/languages/SOLIDITY.md +580 -580
  198. package/templates/languages/SQL.md +137 -137
  199. package/templates/languages/SWIFT.md +466 -466
  200. package/templates/languages/TYPESCRIPT.md +591 -591
  201. package/templates/languages/ZIG.md +265 -265
  202. package/templates/modules/ATLASSIAN.md +255 -255
  203. package/templates/modules/CONTEXT7.md +54 -54
  204. package/templates/modules/FIGMA.md +267 -267
  205. package/templates/modules/GITHUB_MCP.md +64 -64
  206. package/templates/modules/GRAFANA.md +328 -328
  207. package/templates/modules/MEMORY.md +126 -126
  208. package/templates/modules/NOTION.md +247 -247
  209. package/templates/modules/PLAYWRIGHT.md +90 -90
  210. package/templates/modules/RULEBOOK_MCP.md +208 -208
  211. package/templates/modules/SERENA.md +337 -337
  212. package/templates/modules/SUPABASE.md +223 -223
  213. package/templates/modules/SYNAP.md +69 -69
  214. package/templates/modules/VECTORIZER.md +63 -63
  215. package/templates/modules/sequential-thinking.md +42 -42
  216. package/templates/ralph/ralph-history.bat +4 -4
  217. package/templates/ralph/ralph-history.sh +5 -5
  218. package/templates/ralph/ralph-init.bat +5 -5
  219. package/templates/ralph/ralph-init.sh +5 -5
  220. package/templates/ralph/ralph-pause.bat +5 -5
  221. package/templates/ralph/ralph-pause.sh +5 -5
  222. package/templates/ralph/ralph-run.bat +5 -5
  223. package/templates/ralph/ralph-run.sh +5 -5
  224. package/templates/ralph/ralph-status.bat +4 -4
  225. package/templates/ralph/ralph-status.sh +5 -5
  226. package/templates/rules/consult-analysis-before-implementing.md +23 -23
  227. package/templates/rules/cpp.md +46 -46
  228. package/templates/rules/csharp.md +44 -44
  229. package/templates/rules/diagnostic-first.md +39 -39
  230. package/templates/rules/fail-twice-escalate.md +46 -46
  231. package/templates/rules/follow-task-sequence.md +36 -36
  232. package/templates/rules/git-safety.md +29 -29
  233. package/templates/rules/go.md +40 -40
  234. package/templates/rules/incremental-implementation.md +56 -56
  235. package/templates/rules/incremental-tests.md +29 -29
  236. package/templates/rules/java.md +43 -43
  237. package/templates/rules/javascript.md +39 -39
  238. package/templates/rules/knowledge-base-usage.md +41 -41
  239. package/templates/rules/multi-agent-teams.md +75 -75
  240. package/templates/rules/no-deferred.md +31 -31
  241. package/templates/rules/no-shortcuts.md +30 -30
  242. package/templates/rules/python.md +43 -43
  243. package/templates/rules/research-first.md +30 -30
  244. package/templates/rules/respect-handoff-trigger.md +41 -41
  245. package/templates/rules/rust.md +40 -40
  246. package/templates/rules/sequential-editing.md +21 -21
  247. package/templates/rules/session-workflow.md +24 -24
  248. package/templates/rules/task-decomposition.md +32 -32
  249. package/templates/rules/typescript.md +40 -40
  250. package/templates/services/AZURE_BLOB.md +184 -184
  251. package/templates/services/CASSANDRA.md +239 -239
  252. package/templates/services/DATADOG.md +26 -26
  253. package/templates/services/DOCKER.md +124 -124
  254. package/templates/services/DOCKER_COMPOSE.md +168 -168
  255. package/templates/services/DYNAMODB.md +308 -308
  256. package/templates/services/ELASTICSEARCH.md +347 -347
  257. package/templates/services/GCS.md +178 -178
  258. package/templates/services/HELM.md +194 -194
  259. package/templates/services/INFLUXDB.md +265 -265
  260. package/templates/services/KAFKA.md +341 -341
  261. package/templates/services/KUBERNETES.md +208 -208
  262. package/templates/services/MARIADB.md +183 -183
  263. package/templates/services/MEMCACHED.md +242 -242
  264. package/templates/services/MINIO.md +201 -201
  265. package/templates/services/MONGODB.md +268 -268
  266. package/templates/services/MYSQL.md +358 -358
  267. package/templates/services/NEO4J.md +247 -247
  268. package/templates/services/OPENTELEMETRY.md +25 -25
  269. package/templates/services/ORACLE.md +290 -290
  270. package/templates/services/PINO.md +24 -24
  271. package/templates/services/POSTGRESQL.md +326 -326
  272. package/templates/services/PROMETHEUS.md +33 -33
  273. package/templates/services/RABBITMQ.md +286 -286
  274. package/templates/services/REDIS.md +292 -292
  275. package/templates/services/S3.md +298 -298
  276. package/templates/services/SENTRY.md +23 -23
  277. package/templates/services/SQLITE.md +294 -294
  278. package/templates/services/SQLSERVER.md +294 -294
  279. package/templates/services/WINSTON.md +30 -30
  280. package/templates/skills/cli/aider/SKILL.md +59 -59
  281. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  282. package/templates/skills/cli/auggie/SKILL.md +42 -42
  283. package/templates/skills/cli/claude/SKILL.md +42 -42
  284. package/templates/skills/cli/cline/SKILL.md +42 -42
  285. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  286. package/templates/skills/cli/codeium/SKILL.md +30 -30
  287. package/templates/skills/cli/codex/SKILL.md +31 -31
  288. package/templates/skills/cli/continue/SKILL.md +44 -44
  289. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  290. package/templates/skills/cli/factory/SKILL.md +28 -28
  291. package/templates/skills/cli/gemini/SKILL.md +45 -45
  292. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  293. package/templates/skills/cli/opencode/SKILL.md +28 -28
  294. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  295. package/templates/skills/core/dag/SKILL.md +314 -314
  296. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  297. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  298. package/templates/skills/core/rulebook/SKILL.md +176 -176
  299. package/templates/skills/core/rulebook-terse/SKILL.md +116 -116
  300. package/templates/skills/core/rulebook-terse-commit/SKILL.md +96 -96
  301. package/templates/skills/core/rulebook-terse-review/SKILL.md +112 -112
  302. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  303. package/templates/skills/dev/analysis/SKILL.md +19 -19
  304. package/templates/skills/dev/api-design/SKILL.md +15 -15
  305. package/templates/skills/dev/architect/SKILL.md +17 -17
  306. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  307. package/templates/skills/dev/db-design/SKILL.md +15 -15
  308. package/templates/skills/dev/debug/SKILL.md +16 -16
  309. package/templates/skills/dev/deploy/SKILL.md +17 -17
  310. package/templates/skills/dev/docs/SKILL.md +17 -17
  311. package/templates/skills/dev/handoff/SKILL.md +27 -27
  312. package/templates/skills/dev/migrate/SKILL.md +15 -15
  313. package/templates/skills/dev/perf/SKILL.md +17 -17
  314. package/templates/skills/dev/refactor/SKILL.md +17 -17
  315. package/templates/skills/dev/research/SKILL.md +14 -14
  316. package/templates/skills/dev/review/SKILL.md +18 -18
  317. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  318. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  319. package/templates/skills/frameworks/django/SKILL.md +93 -93
  320. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  321. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  322. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  323. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  324. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  325. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  326. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  327. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  328. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  329. package/templates/skills/frameworks/react/SKILL.md +48 -48
  330. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  331. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  332. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  333. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  334. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  335. package/templates/skills/ides/copilot/SKILL.md +47 -47
  336. package/templates/skills/ides/cursor/SKILL.md +53 -53
  337. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  338. package/templates/skills/ides/replit/SKILL.md +46 -46
  339. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  340. package/templates/skills/ides/vscode/SKILL.md +50 -50
  341. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  342. package/templates/skills/ides/zed/SKILL.md +42 -42
  343. package/templates/skills/languages/c/SKILL.md +343 -343
  344. package/templates/skills/languages/cpp/SKILL.md +753 -753
  345. package/templates/skills/languages/csharp/SKILL.md +427 -427
  346. package/templates/skills/languages/elixir/SKILL.md +464 -464
  347. package/templates/skills/languages/erlang/SKILL.md +371 -371
  348. package/templates/skills/languages/go/SKILL.md +655 -655
  349. package/templates/skills/languages/haskell/SKILL.md +187 -187
  350. package/templates/skills/languages/java/SKILL.md +617 -617
  351. package/templates/skills/languages/javascript/SKILL.md +641 -641
  352. package/templates/skills/languages/julia/SKILL.md +107 -107
  353. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  354. package/templates/skills/languages/lisp/SKILL.md +110 -110
  355. package/templates/skills/languages/lua/SKILL.md +84 -84
  356. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  357. package/templates/skills/languages/php/SKILL.md +426 -426
  358. package/templates/skills/languages/python/SKILL.md +692 -692
  359. package/templates/skills/languages/ruby/SKILL.md +431 -431
  360. package/templates/skills/languages/rust/SKILL.md +487 -487
  361. package/templates/skills/languages/sas/SKILL.md +83 -83
  362. package/templates/skills/languages/scala/SKILL.md +358 -358
  363. package/templates/skills/languages/solidity/SKILL.md +590 -590
  364. package/templates/skills/languages/sql/SKILL.md +147 -147
  365. package/templates/skills/languages/swift/SKILL.md +476 -476
  366. package/templates/skills/languages/typescript/SKILL.md +302 -302
  367. package/templates/skills/languages/zig/SKILL.md +275 -275
  368. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  369. package/templates/skills/modules/context7/SKILL.md +64 -64
  370. package/templates/skills/modules/figma/SKILL.md +277 -277
  371. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  372. package/templates/skills/modules/grafana/SKILL.md +338 -338
  373. package/templates/skills/modules/memory/SKILL.md +73 -73
  374. package/templates/skills/modules/notion/SKILL.md +257 -257
  375. package/templates/skills/modules/playwright/SKILL.md +100 -100
  376. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  377. package/templates/skills/modules/serena/SKILL.md +347 -347
  378. package/templates/skills/modules/supabase/SKILL.md +233 -233
  379. package/templates/skills/modules/synap/SKILL.md +79 -79
  380. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  381. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  382. package/templates/skills/services/cassandra/SKILL.md +249 -249
  383. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  384. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  385. package/templates/skills/services/gcs/SKILL.md +188 -188
  386. package/templates/skills/services/influxdb/SKILL.md +275 -275
  387. package/templates/skills/services/kafka/SKILL.md +351 -351
  388. package/templates/skills/services/mariadb/SKILL.md +193 -193
  389. package/templates/skills/services/memcached/SKILL.md +252 -252
  390. package/templates/skills/services/minio/SKILL.md +211 -211
  391. package/templates/skills/services/mongodb/SKILL.md +278 -278
  392. package/templates/skills/services/mysql/SKILL.md +368 -368
  393. package/templates/skills/services/neo4j/SKILL.md +257 -257
  394. package/templates/skills/services/oracle/SKILL.md +300 -300
  395. package/templates/skills/services/postgresql/SKILL.md +336 -336
  396. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  397. package/templates/skills/services/redis/SKILL.md +302 -302
  398. package/templates/skills/services/s3/SKILL.md +308 -308
  399. package/templates/skills/services/sqlite/SKILL.md +304 -304
  400. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  401. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  402. package/templates/skills/workflows/ralph/install.sh +87 -87
  403. package/templates/skills/workflows/ralph/manifest.json +158 -158
  404. package/templates/workflows/codespell.yml +31 -31
  405. package/templates/workflows/cpp-lint.yml +47 -47
  406. package/templates/workflows/cpp-publish.yml +119 -119
  407. package/templates/workflows/cpp-test.yml +77 -77
  408. package/templates/workflows/dotnet-lint.yml +29 -29
  409. package/templates/workflows/dotnet-publish.yml +40 -40
  410. package/templates/workflows/dotnet-test.yml +41 -41
  411. package/templates/workflows/elixir-lint.yml +45 -45
  412. package/templates/workflows/elixir-publish.yml +49 -49
  413. package/templates/workflows/elixir-test.yml +54 -54
  414. package/templates/workflows/erlang-lint.yml +47 -47
  415. package/templates/workflows/erlang-test.yml +62 -62
  416. package/templates/workflows/go-lint.yml +39 -39
  417. package/templates/workflows/go-publish.yml +95 -95
  418. package/templates/workflows/go-test.yml +59 -59
  419. package/templates/workflows/java-lint.yml +60 -60
  420. package/templates/workflows/java-publish.yml +120 -120
  421. package/templates/workflows/java-test.yml +85 -85
  422. package/templates/workflows/kotlin-lint.yml +34 -34
  423. package/templates/workflows/kotlin-publish.yml +56 -56
  424. package/templates/workflows/kotlin-test.yml +48 -48
  425. package/templates/workflows/php-lint.yml +39 -39
  426. package/templates/workflows/php-publish.yml +50 -50
  427. package/templates/workflows/php-test.yml +54 -54
  428. package/templates/workflows/python-lint.yml +47 -47
  429. package/templates/workflows/python-publish.yml +91 -91
  430. package/templates/workflows/python-test.yml +59 -59
  431. package/templates/workflows/rust-lint.yml +54 -54
  432. package/templates/workflows/rust-publish.yml +66 -66
  433. package/templates/workflows/rust-test.yml +75 -75
  434. package/templates/workflows/solidity-lint.yml +41 -41
  435. package/templates/workflows/solidity-test.yml +47 -47
  436. package/templates/workflows/swift-lint.yml +32 -32
  437. package/templates/workflows/swift-publish.yml +58 -58
  438. package/templates/workflows/swift-test.yml +44 -44
  439. package/templates/workflows/typescript-publish.yml +60 -60
  440. package/templates/workflows/typescript-test.yml +73 -73
  441. package/templates/workflows/zig-lint.yml +27 -27
  442. package/templates/workflows/zig-test.yml +40 -40
  443. package/dist/hooks/terse-activate.d.ts +0 -59
  444. package/dist/hooks/terse-activate.d.ts.map +0 -1
  445. package/dist/hooks/terse-activate.js +0 -149
  446. package/dist/hooks/terse-activate.js.map +0 -1
  447. package/dist/hooks/terse-config.d.ts +0 -51
  448. package/dist/hooks/terse-config.d.ts.map +0 -1
  449. package/dist/hooks/terse-config.js +0 -130
  450. package/dist/hooks/terse-config.js.map +0 -1
  451. package/dist/hooks/terse-mode-tracker.d.ts +0 -78
  452. package/dist/hooks/terse-mode-tracker.d.ts.map +0 -1
  453. package/dist/hooks/terse-mode-tracker.js +0 -213
  454. package/dist/hooks/terse-mode-tracker.js.map +0 -1
@@ -1,427 +1,427 @@
1
- ---
2
- name: "C#"
3
- description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
- version: "1.0.0"
5
- category: "languages"
6
- author: "Rulebook"
7
- tags: ["languages", "language"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- CSHARP:START -->
12
- # C# Project Rules
13
-
14
- ## Agent Automation Commands
15
-
16
- **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
-
18
- ```bash
19
- # Complete quality check sequence:
20
- dotnet format --verify-no-changes # Format check
21
- dotnet build # Build + compile check
22
- dotnet test # All tests (100% pass)
23
- dotnet test --collect:"XPlat Code Coverage" # Coverage (95%+ required)
24
-
25
- # Security audit:
26
- dotnet list package --vulnerable # Vulnerability scan
27
- dotnet list package --outdated # Check outdated deps
28
- ```
29
-
30
- ## C# Configuration
31
-
32
- **CRITICAL**: Use .NET 8+ with C# 12+.
33
-
34
- - **Version**: .NET 8.0+
35
- - **C# Version**: 12+
36
- - **Target**: net8.0
37
- - **Nullable**: Enabled
38
- - **LangVersion**: latest
39
-
40
- ### Project File Requirements
41
-
42
- ```xml
43
- <Project Sdk="Microsoft.NET.Sdk">
44
- <PropertyGroup>
45
- <TargetFramework>net8.0</TargetFramework>
46
- <LangVersion>latest</LangVersion>
47
- <Nullable>enable</Nullable>
48
- <ImplicitUsings>enable</ImplicitUsings>
49
- <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
50
- <AnalysisMode>All</AnalysisMode>
51
- <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
52
-
53
- <!-- Package Metadata -->
54
- <PackageId>Your.Package.Name</PackageId>
55
- <Version>1.0.0</Version>
56
- <Authors>Your Name</Authors>
57
- <Company>Your Company</Company>
58
- <Description>A short description of your package</Description>
59
- <PackageLicenseExpression>MIT</PackageLicenseExpression>
60
- <PackageProjectUrl>https://github.com/your-org/your-project</PackageProjectUrl>
61
- <RepositoryUrl>https://github.com/your-org/your-project</RepositoryUrl>
62
- <RepositoryType>git</RepositoryType>
63
- <PackageTags>your;tags</PackageTags>
64
-
65
- <!-- Documentation -->
66
- <GenerateDocumentationFile>true</GenerateDocumentationFile>
67
- <NoWarn>$(NoWarn);1591</NoWarn>
68
- </PropertyGroup>
69
-
70
- <ItemGroup>
71
- <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0">
72
- <PrivateAssets>all</PrivateAssets>
73
- <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
74
- </PackageReference>
75
- </ItemGroup>
76
- </Project>
77
- ```
78
-
79
- ## Code Quality Standards
80
-
81
- ### Mandatory Quality Checks
82
-
83
- **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
84
-
85
- **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
86
-
87
- ```bash
88
- # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
89
-
90
- # 1. Format check (matches workflow - use --verify-no-changes!)
91
- dotnet format --verify-no-changes
92
-
93
- # 2. Build (MUST pass with no warnings - matches workflow)
94
- dotnet build --no-incremental --warnaserror
95
-
96
- # 3. Run all tests (MUST pass 100% - matches workflow)
97
- dotnet test --no-build
98
-
99
- # 4. Check coverage (MUST meet threshold)
100
- dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
101
-
102
- # If ANY fails: ❌ DO NOT COMMIT - Fix first!
103
- ```
104
-
105
- **If ANY of these fail, you MUST fix the issues before committing.**
106
-
107
- **Why This Matters:**
108
- - CI/CD failures happen when local commands differ from workflows
109
- - Example: Using `dotnet format` locally but `dotnet format --verify-no-changes` in CI = failure
110
- - Example: Missing `--warnaserror` flag = warnings pass locally but fail in CI
111
-
112
- ### Code Style
113
-
114
- Use `.editorconfig` for consistent code style:
115
-
116
- ```ini
117
- root = true
118
-
119
- [*]
120
- charset = utf-8
121
- indent_style = space
122
- indent_size = 4
123
- insert_final_newline = true
124
- trim_trailing_whitespace = true
125
-
126
- [*.{cs,csx,vb,vbx}]
127
- indent_size = 4
128
-
129
- # C# Code Style Rules
130
- [*.cs]
131
- # Organize usings
132
- dotnet_sort_system_directives_first = true
133
- dotnet_separate_import_directive_groups = false
134
-
135
- # this. preferences
136
- dotnet_style_qualification_for_field = false:warning
137
- dotnet_style_qualification_for_property = false:warning
138
- dotnet_style_qualification_for_method = false:warning
139
- dotnet_style_qualification_for_event = false:warning
140
-
141
- # Language keywords vs BCL types preferences
142
- dotnet_style_predefined_type_for_locals_parameters_members = true:warning
143
- dotnet_style_predefined_type_for_member_access = true:warning
144
-
145
- # Modifier preferences
146
- dotnet_style_require_accessibility_modifiers = always:warning
147
- csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:warning
148
-
149
- # Expression preferences
150
- csharp_style_var_for_built_in_types = true:warning
151
- csharp_style_var_when_type_is_apparent = true:warning
152
- csharp_style_var_elsewhere = true:warning
153
-
154
- # Pattern matching
155
- csharp_style_pattern_matching_over_is_with_cast_check = true:warning
156
- csharp_style_pattern_matching_over_as_with_null_check = true:warning
157
-
158
- # Null-checking preferences
159
- csharp_style_throw_expression = true:warning
160
- csharp_style_conditional_delegate_call = true:warning
161
-
162
- # Code block preferences
163
- csharp_prefer_braces = true:warning
164
- csharp_prefer_simple_using_statement = true:warning
165
-
166
- # Naming conventions
167
- dotnet_naming_rule.interface_should_be_begins_with_i.severity = warning
168
- dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
169
- dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
170
-
171
- dotnet_naming_rule.types_should_be_pascal_case.severity = warning
172
- dotnet_naming_rule.types_should_be_pascal_case.symbols = types
173
- dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
174
-
175
- dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning
176
- dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
177
- dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
178
-
179
- # Symbol specifications
180
- dotnet_naming_symbols.interface.applicable_kinds = interface
181
- dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
182
-
183
- dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
184
- dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
185
-
186
- dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
187
- dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
188
-
189
- # Naming styles
190
- dotnet_naming_style.begins_with_i.required_prefix = I
191
- dotnet_naming_style.begins_with_i.required_suffix =
192
- dotnet_naming_style.begins_with_i.word_separator =
193
- dotnet_naming_style.begins_with_i.capitalization = pascal_case
194
-
195
- dotnet_naming_style.pascal_case.required_prefix =
196
- dotnet_naming_style.pascal_case.required_suffix =
197
- dotnet_naming_style.pascal_case.word_separator =
198
- dotnet_naming_style.pascal_case.capitalization = pascal_case
199
- ```
200
-
201
- ### Testing
202
-
203
- - **Framework**: xUnit (recommended) or NUnit
204
- - **Location**: Separate test project
205
- - **Coverage**: Coverlet
206
- - **Coverage Threshold**: 95%+
207
-
208
- Example test structure:
209
- ```csharp
210
- using Xunit;
211
-
212
- namespace YourProject.Tests;
213
-
214
- public class MyClassTests
215
- {
216
- [Fact]
217
- public void Process_ValidInput_ReturnsExpectedResult()
218
- {
219
- // Arrange
220
- var sut = new MyClass();
221
- var input = "test";
222
-
223
- // Act
224
- var result = sut.Process(input);
225
-
226
- // Assert
227
- Assert.Equal("TEST", result);
228
- }
229
-
230
- [Theory]
231
- [InlineData("")]
232
- [InlineData(null)]
233
- public void Process_InvalidInput_ThrowsArgumentException(string input)
234
- {
235
- // Arrange
236
- var sut = new MyClass();
237
-
238
- // Act & Assert
239
- Assert.Throws<ArgumentException>(() => sut.Process(input));
240
- }
241
- }
242
- ```
243
-
244
- ### Documentation
245
-
246
- - Use XML documentation comments
247
- - Document all public APIs
248
- - Include `<summary>`, `<param>`, `<returns>`, `<exception>`
249
-
250
- Example:
251
- ```csharp
252
- namespace YourProject;
253
-
254
- /// <summary>
255
- /// Provides functionality for processing data.
256
- /// </summary>
257
- public class MyClass
258
- {
259
- /// <summary>
260
- /// Processes the input string and converts it to uppercase.
261
- /// </summary>
262
- /// <param name="input">The input string to process.</param>
263
- /// <returns>The processed string in uppercase.</returns>
264
- /// <exception cref="ArgumentException">Thrown when input is null or empty.</exception>
265
- /// <example>
266
- /// <code>
267
- /// var processor = new MyClass();
268
- /// var result = processor.Process("hello");
269
- /// // result is "HELLO"
270
- /// </code>
271
- /// </example>
272
- public string Process(string input)
273
- {
274
- if (string.IsNullOrEmpty(input))
275
- {
276
- throw new ArgumentException("Input cannot be null or empty.", nameof(input));
277
- }
278
-
279
- return input.ToUpperInvariant();
280
- }
281
- }
282
- ```
283
-
284
- ## Project Structure
285
-
286
- ```
287
- project/
288
- ├── src/
289
- │ └── YourProject/
290
- │ ├── YourProject.csproj
291
- │ ├── Class1.cs
292
- │ └── ...
293
- ├── tests/
294
- │ └── YourProject.Tests/
295
- │ ├── YourProject.Tests.csproj
296
- │ ├── Class1Tests.cs
297
- │ └── ...
298
- ├── docs/ # Project documentation
299
- ├── .editorconfig # Code style configuration
300
- ├── Directory.Build.props # Shared MSBuild properties
301
- ├── Directory.Packages.props # Central package management
302
- ├── YourProject.sln # Solution file
303
- ├── README.md # Project overview (allowed in root)
304
- ├── CHANGELOG.md # Version history (allowed in root)
305
- └── LICENSE # Project license (allowed in root)
306
- ```
307
-
308
- ## Nullable Reference Types
309
-
310
- - Enable nullable reference types
311
- - Use `?` for nullable types
312
- - Use null-forgiving operator `!` sparingly
313
-
314
- Example:
315
- ```csharp
316
- public class UserService
317
- {
318
- private readonly ILogger<UserService> _logger;
319
-
320
- public UserService(ILogger<UserService> logger)
321
- {
322
- _logger = logger ?? throw new ArgumentNullException(nameof(logger));
323
- }
324
-
325
- public User? FindUser(string? username)
326
- {
327
- if (string.IsNullOrEmpty(username))
328
- {
329
- return null;
330
- }
331
-
332
- // Implementation
333
- return new User { Username = username };
334
- }
335
-
336
- public User GetUser(string username)
337
- {
338
- var user = FindUser(username);
339
- return user ?? throw new InvalidOperationException("User not found");
340
- }
341
- }
342
- ```
343
-
344
- ## Async/Await Best Practices
345
-
346
- - Use `async`/`await` for I/O operations
347
- - Don't block on async code
348
- - Use `ConfigureAwait(false)` in libraries
349
- - Return `Task` or `ValueTask`
350
-
351
- Example:
352
- ```csharp
353
- public class DataService
354
- {
355
- private readonly HttpClient _httpClient;
356
-
357
- public async Task<string> FetchDataAsync(string url, CancellationToken cancellationToken = default)
358
- {
359
- var response = await _httpClient.GetAsync(url, cancellationToken).ConfigureAwait(false);
360
- response.EnsureSuccessStatusCode();
361
-
362
- return await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false);
363
- }
364
- }
365
- ```
366
-
367
- ## CI/CD Requirements
368
-
369
- Must include GitHub Actions workflows for:
370
-
371
- 1. **Testing** (`dotnet-test.yml`):
372
- - Test on ubuntu-latest, windows-latest, macos-latest
373
- - Test on .NET 8.0
374
- - Upload coverage reports
375
-
376
- 2. **Linting** (`dotnet-lint.yml`):
377
- - Format check: `dotnet format --verify-no-changes`
378
- - Build: `dotnet build --no-incremental`
379
- - Analyzers enabled
380
-
381
- ## Package Publication
382
-
383
- ### Publishing to NuGet
384
-
385
- **Prerequisites:**
386
- 1. Create account at https://www.nuget.org
387
- 2. Generate API key from account settings
388
- 3. Add `NUGET_API_KEY` to GitHub repository secrets
389
-
390
- **Publishing Workflow:**
391
-
392
- 1. Update version in .csproj
393
- 2. Update CHANGELOG.md
394
- 3. Run quality checks:
395
- ```bash
396
- dotnet format --verify-no-changes
397
- dotnet build --configuration Release
398
- dotnet test --configuration Release
399
- ```
400
-
401
- 4. Pack: `dotnet pack --configuration Release`
402
- 5. Create git tag: `git tag v1.0.0 && git push --tags`
403
- 6. GitHub Actions automatically publishes to NuGet
404
- 7. Or manual publish: `dotnet nuget push bin/Release/*.nupkg --api-key $NUGET_API_KEY --source https://api.nuget.org/v3/index.json`
405
-
406
- **Publishing Checklist:**
407
-
408
- - ✅ All tests passing
409
- - ✅ Code formatted (`dotnet format`)
410
- - ✅ No build warnings
411
- - ✅ Version updated in .csproj
412
- - ✅ CHANGELOG.md updated
413
- - ✅ README.md up to date
414
- - ✅ LICENSE file present
415
- - ✅ XML documentation generated
416
- - ✅ Package metadata complete
417
- - ✅ Verify with `dotnet pack`
418
-
419
- **Semantic Versioning:**
420
-
421
- Use `<Version>` in .csproj with SemVer:
422
- - **MAJOR**: Breaking API changes
423
- - **MINOR**: New features (backwards compatible)
424
- - **PATCH**: Bug fixes (backwards compatible)
425
-
426
- <!-- CSHARP:END -->
427
-
1
+ ---
2
+ name: "C#"
3
+ description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
+ version: "1.0.0"
5
+ category: "languages"
6
+ author: "Rulebook"
7
+ tags: ["languages", "language"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+ <!-- CSHARP:START -->
12
+ # C# Project Rules
13
+
14
+ ## Agent Automation Commands
15
+
16
+ **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
+
18
+ ```bash
19
+ # Complete quality check sequence:
20
+ dotnet format --verify-no-changes # Format check
21
+ dotnet build # Build + compile check
22
+ dotnet test # All tests (100% pass)
23
+ dotnet test --collect:"XPlat Code Coverage" # Coverage (95%+ required)
24
+
25
+ # Security audit:
26
+ dotnet list package --vulnerable # Vulnerability scan
27
+ dotnet list package --outdated # Check outdated deps
28
+ ```
29
+
30
+ ## C# Configuration
31
+
32
+ **CRITICAL**: Use .NET 8+ with C# 12+.
33
+
34
+ - **Version**: .NET 8.0+
35
+ - **C# Version**: 12+
36
+ - **Target**: net8.0
37
+ - **Nullable**: Enabled
38
+ - **LangVersion**: latest
39
+
40
+ ### Project File Requirements
41
+
42
+ ```xml
43
+ <Project Sdk="Microsoft.NET.Sdk">
44
+ <PropertyGroup>
45
+ <TargetFramework>net8.0</TargetFramework>
46
+ <LangVersion>latest</LangVersion>
47
+ <Nullable>enable</Nullable>
48
+ <ImplicitUsings>enable</ImplicitUsings>
49
+ <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
50
+ <AnalysisMode>All</AnalysisMode>
51
+ <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
52
+
53
+ <!-- Package Metadata -->
54
+ <PackageId>Your.Package.Name</PackageId>
55
+ <Version>1.0.0</Version>
56
+ <Authors>Your Name</Authors>
57
+ <Company>Your Company</Company>
58
+ <Description>A short description of your package</Description>
59
+ <PackageLicenseExpression>MIT</PackageLicenseExpression>
60
+ <PackageProjectUrl>https://github.com/your-org/your-project</PackageProjectUrl>
61
+ <RepositoryUrl>https://github.com/your-org/your-project</RepositoryUrl>
62
+ <RepositoryType>git</RepositoryType>
63
+ <PackageTags>your;tags</PackageTags>
64
+
65
+ <!-- Documentation -->
66
+ <GenerateDocumentationFile>true</GenerateDocumentationFile>
67
+ <NoWarn>$(NoWarn);1591</NoWarn>
68
+ </PropertyGroup>
69
+
70
+ <ItemGroup>
71
+ <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0">
72
+ <PrivateAssets>all</PrivateAssets>
73
+ <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
74
+ </PackageReference>
75
+ </ItemGroup>
76
+ </Project>
77
+ ```
78
+
79
+ ## Code Quality Standards
80
+
81
+ ### Mandatory Quality Checks
82
+
83
+ **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
84
+
85
+ **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
86
+
87
+ ```bash
88
+ # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
89
+
90
+ # 1. Format check (matches workflow - use --verify-no-changes!)
91
+ dotnet format --verify-no-changes
92
+
93
+ # 2. Build (MUST pass with no warnings - matches workflow)
94
+ dotnet build --no-incremental --warnaserror
95
+
96
+ # 3. Run all tests (MUST pass 100% - matches workflow)
97
+ dotnet test --no-build
98
+
99
+ # 4. Check coverage (MUST meet threshold)
100
+ dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
101
+
102
+ # If ANY fails: ❌ DO NOT COMMIT - Fix first!
103
+ ```
104
+
105
+ **If ANY of these fail, you MUST fix the issues before committing.**
106
+
107
+ **Why This Matters:**
108
+ - CI/CD failures happen when local commands differ from workflows
109
+ - Example: Using `dotnet format` locally but `dotnet format --verify-no-changes` in CI = failure
110
+ - Example: Missing `--warnaserror` flag = warnings pass locally but fail in CI
111
+
112
+ ### Code Style
113
+
114
+ Use `.editorconfig` for consistent code style:
115
+
116
+ ```ini
117
+ root = true
118
+
119
+ [*]
120
+ charset = utf-8
121
+ indent_style = space
122
+ indent_size = 4
123
+ insert_final_newline = true
124
+ trim_trailing_whitespace = true
125
+
126
+ [*.{cs,csx,vb,vbx}]
127
+ indent_size = 4
128
+
129
+ # C# Code Style Rules
130
+ [*.cs]
131
+ # Organize usings
132
+ dotnet_sort_system_directives_first = true
133
+ dotnet_separate_import_directive_groups = false
134
+
135
+ # this. preferences
136
+ dotnet_style_qualification_for_field = false:warning
137
+ dotnet_style_qualification_for_property = false:warning
138
+ dotnet_style_qualification_for_method = false:warning
139
+ dotnet_style_qualification_for_event = false:warning
140
+
141
+ # Language keywords vs BCL types preferences
142
+ dotnet_style_predefined_type_for_locals_parameters_members = true:warning
143
+ dotnet_style_predefined_type_for_member_access = true:warning
144
+
145
+ # Modifier preferences
146
+ dotnet_style_require_accessibility_modifiers = always:warning
147
+ csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:warning
148
+
149
+ # Expression preferences
150
+ csharp_style_var_for_built_in_types = true:warning
151
+ csharp_style_var_when_type_is_apparent = true:warning
152
+ csharp_style_var_elsewhere = true:warning
153
+
154
+ # Pattern matching
155
+ csharp_style_pattern_matching_over_is_with_cast_check = true:warning
156
+ csharp_style_pattern_matching_over_as_with_null_check = true:warning
157
+
158
+ # Null-checking preferences
159
+ csharp_style_throw_expression = true:warning
160
+ csharp_style_conditional_delegate_call = true:warning
161
+
162
+ # Code block preferences
163
+ csharp_prefer_braces = true:warning
164
+ csharp_prefer_simple_using_statement = true:warning
165
+
166
+ # Naming conventions
167
+ dotnet_naming_rule.interface_should_be_begins_with_i.severity = warning
168
+ dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
169
+ dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
170
+
171
+ dotnet_naming_rule.types_should_be_pascal_case.severity = warning
172
+ dotnet_naming_rule.types_should_be_pascal_case.symbols = types
173
+ dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
174
+
175
+ dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning
176
+ dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
177
+ dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
178
+
179
+ # Symbol specifications
180
+ dotnet_naming_symbols.interface.applicable_kinds = interface
181
+ dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
182
+
183
+ dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
184
+ dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
185
+
186
+ dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
187
+ dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
188
+
189
+ # Naming styles
190
+ dotnet_naming_style.begins_with_i.required_prefix = I
191
+ dotnet_naming_style.begins_with_i.required_suffix =
192
+ dotnet_naming_style.begins_with_i.word_separator =
193
+ dotnet_naming_style.begins_with_i.capitalization = pascal_case
194
+
195
+ dotnet_naming_style.pascal_case.required_prefix =
196
+ dotnet_naming_style.pascal_case.required_suffix =
197
+ dotnet_naming_style.pascal_case.word_separator =
198
+ dotnet_naming_style.pascal_case.capitalization = pascal_case
199
+ ```
200
+
201
+ ### Testing
202
+
203
+ - **Framework**: xUnit (recommended) or NUnit
204
+ - **Location**: Separate test project
205
+ - **Coverage**: Coverlet
206
+ - **Coverage Threshold**: 95%+
207
+
208
+ Example test structure:
209
+ ```csharp
210
+ using Xunit;
211
+
212
+ namespace YourProject.Tests;
213
+
214
+ public class MyClassTests
215
+ {
216
+ [Fact]
217
+ public void Process_ValidInput_ReturnsExpectedResult()
218
+ {
219
+ // Arrange
220
+ var sut = new MyClass();
221
+ var input = "test";
222
+
223
+ // Act
224
+ var result = sut.Process(input);
225
+
226
+ // Assert
227
+ Assert.Equal("TEST", result);
228
+ }
229
+
230
+ [Theory]
231
+ [InlineData("")]
232
+ [InlineData(null)]
233
+ public void Process_InvalidInput_ThrowsArgumentException(string input)
234
+ {
235
+ // Arrange
236
+ var sut = new MyClass();
237
+
238
+ // Act & Assert
239
+ Assert.Throws<ArgumentException>(() => sut.Process(input));
240
+ }
241
+ }
242
+ ```
243
+
244
+ ### Documentation
245
+
246
+ - Use XML documentation comments
247
+ - Document all public APIs
248
+ - Include `<summary>`, `<param>`, `<returns>`, `<exception>`
249
+
250
+ Example:
251
+ ```csharp
252
+ namespace YourProject;
253
+
254
+ /// <summary>
255
+ /// Provides functionality for processing data.
256
+ /// </summary>
257
+ public class MyClass
258
+ {
259
+ /// <summary>
260
+ /// Processes the input string and converts it to uppercase.
261
+ /// </summary>
262
+ /// <param name="input">The input string to process.</param>
263
+ /// <returns>The processed string in uppercase.</returns>
264
+ /// <exception cref="ArgumentException">Thrown when input is null or empty.</exception>
265
+ /// <example>
266
+ /// <code>
267
+ /// var processor = new MyClass();
268
+ /// var result = processor.Process("hello");
269
+ /// // result is "HELLO"
270
+ /// </code>
271
+ /// </example>
272
+ public string Process(string input)
273
+ {
274
+ if (string.IsNullOrEmpty(input))
275
+ {
276
+ throw new ArgumentException("Input cannot be null or empty.", nameof(input));
277
+ }
278
+
279
+ return input.ToUpperInvariant();
280
+ }
281
+ }
282
+ ```
283
+
284
+ ## Project Structure
285
+
286
+ ```
287
+ project/
288
+ ├── src/
289
+ │ └── YourProject/
290
+ │ ├── YourProject.csproj
291
+ │ ├── Class1.cs
292
+ │ └── ...
293
+ ├── tests/
294
+ │ └── YourProject.Tests/
295
+ │ ├── YourProject.Tests.csproj
296
+ │ ├── Class1Tests.cs
297
+ │ └── ...
298
+ ├── docs/ # Project documentation
299
+ ├── .editorconfig # Code style configuration
300
+ ├── Directory.Build.props # Shared MSBuild properties
301
+ ├── Directory.Packages.props # Central package management
302
+ ├── YourProject.sln # Solution file
303
+ ├── README.md # Project overview (allowed in root)
304
+ ├── CHANGELOG.md # Version history (allowed in root)
305
+ └── LICENSE # Project license (allowed in root)
306
+ ```
307
+
308
+ ## Nullable Reference Types
309
+
310
+ - Enable nullable reference types
311
+ - Use `?` for nullable types
312
+ - Use null-forgiving operator `!` sparingly
313
+
314
+ Example:
315
+ ```csharp
316
+ public class UserService
317
+ {
318
+ private readonly ILogger<UserService> _logger;
319
+
320
+ public UserService(ILogger<UserService> logger)
321
+ {
322
+ _logger = logger ?? throw new ArgumentNullException(nameof(logger));
323
+ }
324
+
325
+ public User? FindUser(string? username)
326
+ {
327
+ if (string.IsNullOrEmpty(username))
328
+ {
329
+ return null;
330
+ }
331
+
332
+ // Implementation
333
+ return new User { Username = username };
334
+ }
335
+
336
+ public User GetUser(string username)
337
+ {
338
+ var user = FindUser(username);
339
+ return user ?? throw new InvalidOperationException("User not found");
340
+ }
341
+ }
342
+ ```
343
+
344
+ ## Async/Await Best Practices
345
+
346
+ - Use `async`/`await` for I/O operations
347
+ - Don't block on async code
348
+ - Use `ConfigureAwait(false)` in libraries
349
+ - Return `Task` or `ValueTask`
350
+
351
+ Example:
352
+ ```csharp
353
+ public class DataService
354
+ {
355
+ private readonly HttpClient _httpClient;
356
+
357
+ public async Task<string> FetchDataAsync(string url, CancellationToken cancellationToken = default)
358
+ {
359
+ var response = await _httpClient.GetAsync(url, cancellationToken).ConfigureAwait(false);
360
+ response.EnsureSuccessStatusCode();
361
+
362
+ return await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false);
363
+ }
364
+ }
365
+ ```
366
+
367
+ ## CI/CD Requirements
368
+
369
+ Must include GitHub Actions workflows for:
370
+
371
+ 1. **Testing** (`dotnet-test.yml`):
372
+ - Test on ubuntu-latest, windows-latest, macos-latest
373
+ - Test on .NET 8.0
374
+ - Upload coverage reports
375
+
376
+ 2. **Linting** (`dotnet-lint.yml`):
377
+ - Format check: `dotnet format --verify-no-changes`
378
+ - Build: `dotnet build --no-incremental`
379
+ - Analyzers enabled
380
+
381
+ ## Package Publication
382
+
383
+ ### Publishing to NuGet
384
+
385
+ **Prerequisites:**
386
+ 1. Create account at https://www.nuget.org
387
+ 2. Generate API key from account settings
388
+ 3. Add `NUGET_API_KEY` to GitHub repository secrets
389
+
390
+ **Publishing Workflow:**
391
+
392
+ 1. Update version in .csproj
393
+ 2. Update CHANGELOG.md
394
+ 3. Run quality checks:
395
+ ```bash
396
+ dotnet format --verify-no-changes
397
+ dotnet build --configuration Release
398
+ dotnet test --configuration Release
399
+ ```
400
+
401
+ 4. Pack: `dotnet pack --configuration Release`
402
+ 5. Create git tag: `git tag v1.0.0 && git push --tags`
403
+ 6. GitHub Actions automatically publishes to NuGet
404
+ 7. Or manual publish: `dotnet nuget push bin/Release/*.nupkg --api-key $NUGET_API_KEY --source https://api.nuget.org/v3/index.json`
405
+
406
+ **Publishing Checklist:**
407
+
408
+ - ✅ All tests passing
409
+ - ✅ Code formatted (`dotnet format`)
410
+ - ✅ No build warnings
411
+ - ✅ Version updated in .csproj
412
+ - ✅ CHANGELOG.md updated
413
+ - ✅ README.md up to date
414
+ - ✅ LICENSE file present
415
+ - ✅ XML documentation generated
416
+ - ✅ Package metadata complete
417
+ - ✅ Verify with `dotnet pack`
418
+
419
+ **Semantic Versioning:**
420
+
421
+ Use `<Version>` in .csproj with SemVer:
422
+ - **MAJOR**: Breaking API changes
423
+ - **MINOR**: New features (backwards compatible)
424
+ - **PATCH**: Bug fixes (backwards compatible)
425
+
426
+ <!-- CSHARP:END -->
427
+