@hivehub/rulebook 4.1.0 → 4.2.1

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