@hivehub/rulebook 4.0.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (348) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +34 -0
  19. package/dist/cli/commands.d.ts +18 -6
  20. package/dist/cli/commands.d.ts.map +1 -1
  21. package/dist/cli/commands.js +717 -406
  22. package/dist/cli/commands.js.map +1 -1
  23. package/dist/core/claude-mcp.d.ts +4 -2
  24. package/dist/core/claude-mcp.d.ts.map +1 -1
  25. package/dist/core/claude-mcp.js +14 -9
  26. package/dist/core/claude-mcp.js.map +1 -1
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +13 -0
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/core/indexer/background-indexer.d.ts +27 -0
  31. package/dist/core/indexer/background-indexer.d.ts.map +1 -0
  32. package/dist/core/indexer/background-indexer.js +156 -0
  33. package/dist/core/indexer/background-indexer.js.map +1 -0
  34. package/dist/core/indexer/file-parser.d.ts +28 -0
  35. package/dist/core/indexer/file-parser.d.ts.map +1 -0
  36. package/dist/core/indexer/file-parser.js +171 -0
  37. package/dist/core/indexer/file-parser.js.map +1 -0
  38. package/dist/core/indexer/indexer-types.d.ts +35 -0
  39. package/dist/core/indexer/indexer-types.d.ts.map +1 -0
  40. package/dist/core/indexer/indexer-types.js +8 -0
  41. package/dist/core/indexer/indexer-types.js.map +1 -0
  42. package/dist/core/workspace/legacy-migrator.d.ts +29 -0
  43. package/dist/core/workspace/legacy-migrator.d.ts.map +1 -0
  44. package/dist/core/workspace/legacy-migrator.js +142 -0
  45. package/dist/core/workspace/legacy-migrator.js.map +1 -0
  46. package/dist/core/workspace/project-worker.d.ts +49 -0
  47. package/dist/core/workspace/project-worker.d.ts.map +1 -0
  48. package/dist/core/workspace/project-worker.js +108 -0
  49. package/dist/core/workspace/project-worker.js.map +1 -0
  50. package/dist/core/workspace/workspace-manager.d.ts +90 -0
  51. package/dist/core/workspace/workspace-manager.d.ts.map +1 -0
  52. package/dist/core/workspace/workspace-manager.js +337 -0
  53. package/dist/core/workspace/workspace-manager.js.map +1 -0
  54. package/dist/core/workspace/workspace-types.d.ts +37 -0
  55. package/dist/core/workspace/workspace-types.d.ts.map +1 -0
  56. package/dist/core/workspace/workspace-types.js +8 -0
  57. package/dist/core/workspace/workspace-types.js.map +1 -0
  58. package/dist/index.js +43 -7
  59. package/dist/index.js.map +1 -1
  60. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  61. package/dist/mcp/rulebook-server.js +450 -81
  62. package/dist/mcp/rulebook-server.js.map +1 -1
  63. package/dist/memory/memory-manager.d.ts +4 -1
  64. package/dist/memory/memory-manager.d.ts.map +1 -1
  65. package/dist/memory/memory-manager.js +33 -4
  66. package/dist/memory/memory-manager.js.map +1 -1
  67. package/dist/memory/memory-search.d.ts +2 -2
  68. package/dist/memory/memory-search.d.ts.map +1 -1
  69. package/dist/memory/memory-search.js +19 -0
  70. package/dist/memory/memory-search.js.map +1 -1
  71. package/dist/memory/memory-store.d.ts +13 -0
  72. package/dist/memory/memory-store.d.ts.map +1 -1
  73. package/dist/memory/memory-store.js +88 -1
  74. package/dist/memory/memory-store.js.map +1 -1
  75. package/dist/memory/memory-types.d.ts +15 -0
  76. package/dist/memory/memory-types.d.ts.map +1 -1
  77. package/dist/types.d.ts +1 -0
  78. package/dist/types.d.ts.map +1 -1
  79. package/package.json +22 -21
  80. package/templates/agents/implementer.md +35 -35
  81. package/templates/agents/researcher.md +34 -34
  82. package/templates/agents/team-lead.md +34 -34
  83. package/templates/agents/tester.md +42 -42
  84. package/templates/ci/rulebook-review.yml +26 -26
  85. package/templates/cli/AIDER.md +49 -49
  86. package/templates/cli/AMAZON_Q.md +25 -25
  87. package/templates/cli/AUGGIE.md +32 -32
  88. package/templates/cli/CLAUDE.md +117 -117
  89. package/templates/cli/CLINE.md +99 -99
  90. package/templates/cli/CODEBUDDY.md +20 -20
  91. package/templates/cli/CODEIUM.md +20 -20
  92. package/templates/cli/CODEX.md +21 -21
  93. package/templates/cli/CONTINUE.md +34 -34
  94. package/templates/cli/CURSOR_CLI.md +62 -62
  95. package/templates/cli/FACTORY.md +18 -18
  96. package/templates/cli/GEMINI.md +35 -35
  97. package/templates/cli/KILOCODE.md +18 -18
  98. package/templates/cli/OPENCODE.md +18 -18
  99. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  100. package/templates/commands/rulebook-memory-save.md +48 -48
  101. package/templates/commands/rulebook-memory-search.md +47 -47
  102. package/templates/commands/rulebook-task-apply.md +67 -67
  103. package/templates/commands/rulebook-task-archive.md +94 -70
  104. package/templates/commands/rulebook-task-create.md +93 -93
  105. package/templates/commands/rulebook-task-list.md +42 -42
  106. package/templates/commands/rulebook-task-show.md +52 -52
  107. package/templates/commands/rulebook-task-validate.md +53 -53
  108. package/templates/core/AGENTS_LEAN.md +25 -25
  109. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  110. package/templates/core/AGENT_AUTOMATION.md +288 -288
  111. package/templates/core/DAG.md +304 -304
  112. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  113. package/templates/core/MULTI_AGENT.md +74 -74
  114. package/templates/core/PLANS.md +28 -28
  115. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  116. package/templates/core/RALPH.md +471 -471
  117. package/templates/core/RULEBOOK.md +1935 -1893
  118. package/templates/core/WORKSPACE.md +69 -0
  119. package/templates/frameworks/ANGULAR.md +36 -36
  120. package/templates/frameworks/DJANGO.md +83 -83
  121. package/templates/frameworks/ELECTRON.md +147 -147
  122. package/templates/frameworks/FLASK.md +38 -38
  123. package/templates/frameworks/FLUTTER.md +55 -55
  124. package/templates/frameworks/JQUERY.md +32 -32
  125. package/templates/frameworks/LARAVEL.md +38 -38
  126. package/templates/frameworks/NESTJS.md +43 -43
  127. package/templates/frameworks/NEXTJS.md +127 -127
  128. package/templates/frameworks/NUXT.md +40 -40
  129. package/templates/frameworks/RAILS.md +66 -66
  130. package/templates/frameworks/REACT.md +38 -38
  131. package/templates/frameworks/REACT_NATIVE.md +47 -47
  132. package/templates/frameworks/SPRING.md +39 -39
  133. package/templates/frameworks/SYMFONY.md +36 -36
  134. package/templates/frameworks/VUE.md +36 -36
  135. package/templates/frameworks/ZEND.md +35 -35
  136. package/templates/git/CI_CD_PATTERNS.md +661 -661
  137. package/templates/git/GITHUB_ACTIONS.md +728 -728
  138. package/templates/git/GITLAB_CI.md +730 -730
  139. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  140. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  141. package/templates/hooks/COMMIT_MSG.md +530 -530
  142. package/templates/hooks/POST_CHECKOUT.md +546 -546
  143. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  144. package/templates/hooks/PRE_COMMIT.md +414 -414
  145. package/templates/hooks/PRE_PUSH.md +601 -601
  146. package/templates/ides/CONTINUE_RULES.md +16 -16
  147. package/templates/ides/COPILOT.md +37 -37
  148. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  149. package/templates/ides/CURSOR.md +43 -43
  150. package/templates/ides/GEMINI_RULES.md +17 -17
  151. package/templates/ides/JETBRAINS_AI.md +35 -35
  152. package/templates/ides/REPLIT.md +36 -36
  153. package/templates/ides/TABNINE.md +29 -29
  154. package/templates/ides/VSCODE.md +40 -40
  155. package/templates/ides/WINDSURF.md +36 -36
  156. package/templates/ides/WINDSURF_RULES.md +14 -14
  157. package/templates/ides/ZED.md +32 -32
  158. package/templates/ides/cursor-mdc/go.mdc +24 -24
  159. package/templates/ides/cursor-mdc/python.mdc +24 -24
  160. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  161. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  162. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  163. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  164. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  165. package/templates/languages/C.md +333 -333
  166. package/templates/languages/CPP.md +743 -743
  167. package/templates/languages/CSHARP.md +417 -417
  168. package/templates/languages/ELIXIR.md +454 -454
  169. package/templates/languages/ERLANG.md +361 -361
  170. package/templates/languages/GO.md +645 -645
  171. package/templates/languages/HASKELL.md +177 -177
  172. package/templates/languages/JAVA.md +607 -607
  173. package/templates/languages/JAVASCRIPT.md +631 -631
  174. package/templates/languages/JULIA.md +97 -97
  175. package/templates/languages/KOTLIN.md +511 -511
  176. package/templates/languages/LISP.md +100 -100
  177. package/templates/languages/LUA.md +74 -74
  178. package/templates/languages/OBJECTIVEC.md +90 -90
  179. package/templates/languages/PHP.md +416 -416
  180. package/templates/languages/PYTHON.md +682 -682
  181. package/templates/languages/RUBY.md +421 -421
  182. package/templates/languages/RUST.md +477 -477
  183. package/templates/languages/SAS.md +73 -73
  184. package/templates/languages/SCALA.md +348 -348
  185. package/templates/languages/SOLIDITY.md +580 -580
  186. package/templates/languages/SQL.md +137 -137
  187. package/templates/languages/SWIFT.md +466 -466
  188. package/templates/languages/TYPESCRIPT.md +591 -591
  189. package/templates/languages/ZIG.md +265 -265
  190. package/templates/modules/ATLASSIAN.md +255 -255
  191. package/templates/modules/CONTEXT7.md +54 -54
  192. package/templates/modules/FIGMA.md +267 -267
  193. package/templates/modules/GITHUB_MCP.md +64 -64
  194. package/templates/modules/GRAFANA.md +328 -328
  195. package/templates/modules/MEMORY.md +126 -126
  196. package/templates/modules/NOTION.md +247 -247
  197. package/templates/modules/PLAYWRIGHT.md +90 -90
  198. package/templates/modules/RULEBOOK_MCP.md +156 -156
  199. package/templates/modules/SERENA.md +337 -337
  200. package/templates/modules/SUPABASE.md +223 -223
  201. package/templates/modules/SYNAP.md +69 -69
  202. package/templates/modules/VECTORIZER.md +63 -63
  203. package/templates/modules/sequential-thinking.md +42 -42
  204. package/templates/ralph/ralph-history.bat +4 -4
  205. package/templates/ralph/ralph-history.sh +5 -5
  206. package/templates/ralph/ralph-init.bat +5 -5
  207. package/templates/ralph/ralph-init.sh +5 -5
  208. package/templates/ralph/ralph-pause.bat +5 -5
  209. package/templates/ralph/ralph-pause.sh +5 -5
  210. package/templates/ralph/ralph-run.bat +5 -5
  211. package/templates/ralph/ralph-run.sh +5 -5
  212. package/templates/ralph/ralph-status.bat +4 -4
  213. package/templates/ralph/ralph-status.sh +5 -5
  214. package/templates/services/AZURE_BLOB.md +184 -184
  215. package/templates/services/CASSANDRA.md +239 -239
  216. package/templates/services/DATADOG.md +26 -26
  217. package/templates/services/DOCKER.md +124 -124
  218. package/templates/services/DOCKER_COMPOSE.md +168 -168
  219. package/templates/services/DYNAMODB.md +308 -308
  220. package/templates/services/ELASTICSEARCH.md +347 -347
  221. package/templates/services/GCS.md +178 -178
  222. package/templates/services/HELM.md +194 -194
  223. package/templates/services/INFLUXDB.md +265 -265
  224. package/templates/services/KAFKA.md +341 -341
  225. package/templates/services/KUBERNETES.md +208 -208
  226. package/templates/services/MARIADB.md +183 -183
  227. package/templates/services/MEMCACHED.md +242 -242
  228. package/templates/services/MINIO.md +201 -201
  229. package/templates/services/MONGODB.md +268 -268
  230. package/templates/services/MYSQL.md +358 -358
  231. package/templates/services/NEO4J.md +247 -247
  232. package/templates/services/OPENTELEMETRY.md +25 -25
  233. package/templates/services/ORACLE.md +290 -290
  234. package/templates/services/PINO.md +24 -24
  235. package/templates/services/POSTGRESQL.md +326 -326
  236. package/templates/services/PROMETHEUS.md +33 -33
  237. package/templates/services/RABBITMQ.md +286 -286
  238. package/templates/services/REDIS.md +292 -292
  239. package/templates/services/S3.md +298 -298
  240. package/templates/services/SENTRY.md +23 -23
  241. package/templates/services/SQLITE.md +294 -294
  242. package/templates/services/SQLSERVER.md +294 -294
  243. package/templates/services/WINSTON.md +30 -30
  244. package/templates/skills/cli/aider/SKILL.md +59 -59
  245. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  246. package/templates/skills/cli/auggie/SKILL.md +42 -42
  247. package/templates/skills/cli/claude/SKILL.md +42 -42
  248. package/templates/skills/cli/cline/SKILL.md +42 -42
  249. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  250. package/templates/skills/cli/codeium/SKILL.md +30 -30
  251. package/templates/skills/cli/codex/SKILL.md +31 -31
  252. package/templates/skills/cli/continue/SKILL.md +44 -44
  253. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  254. package/templates/skills/cli/factory/SKILL.md +28 -28
  255. package/templates/skills/cli/gemini/SKILL.md +45 -45
  256. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  257. package/templates/skills/cli/opencode/SKILL.md +28 -28
  258. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  259. package/templates/skills/core/dag/SKILL.md +314 -314
  260. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  261. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  262. package/templates/skills/core/rulebook/SKILL.md +176 -176
  263. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  264. package/templates/skills/frameworks/django/SKILL.md +93 -93
  265. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  266. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  267. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  268. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  269. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  270. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  271. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  272. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  273. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  274. package/templates/skills/frameworks/react/SKILL.md +48 -48
  275. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  276. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  277. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  278. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  279. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  280. package/templates/skills/ides/copilot/SKILL.md +47 -47
  281. package/templates/skills/ides/cursor/SKILL.md +53 -53
  282. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  283. package/templates/skills/ides/replit/SKILL.md +46 -46
  284. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  285. package/templates/skills/ides/vscode/SKILL.md +50 -50
  286. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  287. package/templates/skills/ides/zed/SKILL.md +42 -42
  288. package/templates/skills/languages/c/SKILL.md +343 -343
  289. package/templates/skills/languages/cpp/SKILL.md +753 -753
  290. package/templates/skills/languages/csharp/SKILL.md +427 -427
  291. package/templates/skills/languages/elixir/SKILL.md +464 -464
  292. package/templates/skills/languages/erlang/SKILL.md +371 -371
  293. package/templates/skills/languages/go/SKILL.md +655 -655
  294. package/templates/skills/languages/haskell/SKILL.md +187 -187
  295. package/templates/skills/languages/java/SKILL.md +617 -617
  296. package/templates/skills/languages/javascript/SKILL.md +641 -641
  297. package/templates/skills/languages/julia/SKILL.md +107 -107
  298. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  299. package/templates/skills/languages/lisp/SKILL.md +110 -110
  300. package/templates/skills/languages/lua/SKILL.md +84 -84
  301. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  302. package/templates/skills/languages/php/SKILL.md +426 -426
  303. package/templates/skills/languages/python/SKILL.md +692 -692
  304. package/templates/skills/languages/ruby/SKILL.md +431 -431
  305. package/templates/skills/languages/rust/SKILL.md +487 -487
  306. package/templates/skills/languages/sas/SKILL.md +83 -83
  307. package/templates/skills/languages/scala/SKILL.md +358 -358
  308. package/templates/skills/languages/solidity/SKILL.md +590 -590
  309. package/templates/skills/languages/sql/SKILL.md +147 -147
  310. package/templates/skills/languages/swift/SKILL.md +476 -476
  311. package/templates/skills/languages/typescript/SKILL.md +302 -302
  312. package/templates/skills/languages/zig/SKILL.md +275 -275
  313. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  314. package/templates/skills/modules/context7/SKILL.md +64 -64
  315. package/templates/skills/modules/figma/SKILL.md +277 -277
  316. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  317. package/templates/skills/modules/grafana/SKILL.md +338 -338
  318. package/templates/skills/modules/memory/SKILL.md +73 -73
  319. package/templates/skills/modules/notion/SKILL.md +257 -257
  320. package/templates/skills/modules/playwright/SKILL.md +100 -100
  321. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  322. package/templates/skills/modules/serena/SKILL.md +347 -347
  323. package/templates/skills/modules/supabase/SKILL.md +233 -233
  324. package/templates/skills/modules/synap/SKILL.md +79 -79
  325. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  326. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  327. package/templates/skills/services/cassandra/SKILL.md +249 -249
  328. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  329. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  330. package/templates/skills/services/gcs/SKILL.md +188 -188
  331. package/templates/skills/services/influxdb/SKILL.md +275 -275
  332. package/templates/skills/services/kafka/SKILL.md +351 -351
  333. package/templates/skills/services/mariadb/SKILL.md +193 -193
  334. package/templates/skills/services/memcached/SKILL.md +252 -252
  335. package/templates/skills/services/minio/SKILL.md +211 -211
  336. package/templates/skills/services/mongodb/SKILL.md +278 -278
  337. package/templates/skills/services/mysql/SKILL.md +368 -368
  338. package/templates/skills/services/neo4j/SKILL.md +257 -257
  339. package/templates/skills/services/oracle/SKILL.md +300 -300
  340. package/templates/skills/services/postgresql/SKILL.md +336 -336
  341. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  342. package/templates/skills/services/redis/SKILL.md +302 -302
  343. package/templates/skills/services/s3/SKILL.md +308 -308
  344. package/templates/skills/services/sqlite/SKILL.md +304 -304
  345. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  346. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  347. package/templates/skills/workflows/ralph/install.sh +87 -87
  348. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -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
+