@hivehub/rulebook 4.2.2 → 4.3.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 (340) 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 +15 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +43 -18
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +10 -2
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +48 -9
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/config-manager.d.ts.map +1 -1
  27. package/dist/core/config-manager.js +1 -2
  28. package/dist/core/config-manager.js.map +1 -1
  29. package/dist/core/generator.d.ts +13 -0
  30. package/dist/core/generator.d.ts.map +1 -1
  31. package/dist/core/generator.js +283 -28
  32. package/dist/core/generator.js.map +1 -1
  33. package/dist/core/indexer/background-indexer.d.ts.map +1 -1
  34. package/dist/core/indexer/background-indexer.js +10 -3
  35. package/dist/core/indexer/background-indexer.js.map +1 -1
  36. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  37. package/dist/core/workspace/workspace-manager.js +2 -6
  38. package/dist/core/workspace/workspace-manager.js.map +1 -1
  39. package/dist/index.js +1 -3
  40. package/dist/index.js.map +1 -1
  41. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  42. package/dist/mcp/rulebook-server.js +23 -10
  43. package/dist/mcp/rulebook-server.js.map +1 -1
  44. package/package.json +21 -22
  45. package/templates/agents/accessibility-reviewer.md +43 -0
  46. package/templates/agents/api-designer.md +42 -0
  47. package/templates/agents/architect.md +51 -0
  48. package/templates/agents/build-engineer.md +36 -0
  49. package/templates/agents/code-reviewer.md +47 -0
  50. package/templates/agents/database-architect.md +41 -0
  51. package/templates/agents/devops-engineer.md +42 -0
  52. package/templates/agents/docs-writer.md +38 -0
  53. package/templates/agents/i18n-engineer.md +42 -0
  54. package/templates/agents/implementer.md +38 -35
  55. package/templates/agents/migration-engineer.md +42 -0
  56. package/templates/agents/performance-engineer.md +49 -0
  57. package/templates/agents/refactoring-agent.md +41 -0
  58. package/templates/agents/researcher.md +38 -34
  59. package/templates/agents/security-reviewer.md +40 -0
  60. package/templates/agents/team-lead.md +37 -34
  61. package/templates/agents/tester.md +45 -42
  62. package/templates/agents/ux-reviewer.md +43 -0
  63. package/templates/ci/rulebook-review.yml +26 -26
  64. package/templates/cli/AIDER.md +49 -49
  65. package/templates/cli/AMAZON_Q.md +25 -25
  66. package/templates/cli/AUGGIE.md +32 -32
  67. package/templates/cli/CLAUDE.md +117 -117
  68. package/templates/cli/CLINE.md +99 -99
  69. package/templates/cli/CODEBUDDY.md +20 -20
  70. package/templates/cli/CODEIUM.md +20 -20
  71. package/templates/cli/CODEX.md +21 -21
  72. package/templates/cli/CONTINUE.md +34 -34
  73. package/templates/cli/CURSOR_CLI.md +62 -62
  74. package/templates/cli/FACTORY.md +18 -18
  75. package/templates/cli/GEMINI.md +35 -35
  76. package/templates/cli/KILOCODE.md +18 -18
  77. package/templates/cli/OPENCODE.md +18 -18
  78. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  79. package/templates/commands/rulebook-memory-save.md +48 -48
  80. package/templates/commands/rulebook-memory-search.md +47 -47
  81. package/templates/commands/rulebook-task-apply.md +67 -67
  82. package/templates/commands/rulebook-task-archive.md +94 -94
  83. package/templates/commands/rulebook-task-create.md +93 -93
  84. package/templates/commands/rulebook-task-list.md +42 -42
  85. package/templates/commands/rulebook-task-show.md +52 -52
  86. package/templates/commands/rulebook-task-validate.md +53 -53
  87. package/templates/core/AGENTS_LEAN.md +25 -25
  88. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  89. package/templates/core/AGENT_AUTOMATION.md +288 -288
  90. package/templates/core/DAG.md +304 -304
  91. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  92. package/templates/core/MULTI_AGENT.md +74 -74
  93. package/templates/core/PLANS.md +28 -28
  94. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  95. package/templates/core/RALPH.md +471 -471
  96. package/templates/core/RULEBOOK.md +1935 -1935
  97. package/templates/frameworks/ANGULAR.md +36 -36
  98. package/templates/frameworks/DJANGO.md +83 -83
  99. package/templates/frameworks/ELECTRON.md +147 -147
  100. package/templates/frameworks/FLASK.md +38 -38
  101. package/templates/frameworks/FLUTTER.md +55 -55
  102. package/templates/frameworks/JQUERY.md +32 -32
  103. package/templates/frameworks/LARAVEL.md +38 -38
  104. package/templates/frameworks/NESTJS.md +43 -43
  105. package/templates/frameworks/NEXTJS.md +127 -127
  106. package/templates/frameworks/NUXT.md +40 -40
  107. package/templates/frameworks/RAILS.md +66 -66
  108. package/templates/frameworks/REACT.md +38 -38
  109. package/templates/frameworks/REACT_NATIVE.md +47 -47
  110. package/templates/frameworks/SPRING.md +39 -39
  111. package/templates/frameworks/SYMFONY.md +36 -36
  112. package/templates/frameworks/VUE.md +36 -36
  113. package/templates/frameworks/ZEND.md +35 -35
  114. package/templates/git/CI_CD_PATTERNS.md +661 -661
  115. package/templates/git/GITHUB_ACTIONS.md +728 -728
  116. package/templates/git/GITLAB_CI.md +730 -730
  117. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  118. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  119. package/templates/hooks/COMMIT_MSG.md +530 -530
  120. package/templates/hooks/POST_CHECKOUT.md +546 -546
  121. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  122. package/templates/hooks/PRE_COMMIT.md +414 -414
  123. package/templates/hooks/PRE_PUSH.md +601 -601
  124. package/templates/ides/CONTINUE_RULES.md +16 -16
  125. package/templates/ides/COPILOT.md +37 -37
  126. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  127. package/templates/ides/CURSOR.md +43 -43
  128. package/templates/ides/GEMINI_RULES.md +17 -17
  129. package/templates/ides/JETBRAINS_AI.md +35 -35
  130. package/templates/ides/REPLIT.md +36 -36
  131. package/templates/ides/TABNINE.md +29 -29
  132. package/templates/ides/VSCODE.md +40 -40
  133. package/templates/ides/WINDSURF.md +36 -36
  134. package/templates/ides/WINDSURF_RULES.md +14 -14
  135. package/templates/ides/ZED.md +32 -32
  136. package/templates/ides/cursor-mdc/go.mdc +24 -24
  137. package/templates/ides/cursor-mdc/python.mdc +24 -24
  138. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  139. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  140. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  141. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  142. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  143. package/templates/languages/C.md +333 -333
  144. package/templates/languages/CPP.md +743 -743
  145. package/templates/languages/CSHARP.md +417 -417
  146. package/templates/languages/ELIXIR.md +454 -454
  147. package/templates/languages/ERLANG.md +361 -361
  148. package/templates/languages/GO.md +645 -645
  149. package/templates/languages/HASKELL.md +177 -177
  150. package/templates/languages/JAVA.md +607 -607
  151. package/templates/languages/JAVASCRIPT.md +631 -631
  152. package/templates/languages/JULIA.md +97 -97
  153. package/templates/languages/KOTLIN.md +511 -511
  154. package/templates/languages/LISP.md +100 -100
  155. package/templates/languages/LUA.md +74 -74
  156. package/templates/languages/OBJECTIVEC.md +90 -90
  157. package/templates/languages/PHP.md +416 -416
  158. package/templates/languages/PYTHON.md +682 -682
  159. package/templates/languages/RUBY.md +421 -421
  160. package/templates/languages/RUST.md +477 -477
  161. package/templates/languages/SAS.md +73 -73
  162. package/templates/languages/SCALA.md +348 -348
  163. package/templates/languages/SOLIDITY.md +580 -580
  164. package/templates/languages/SQL.md +137 -137
  165. package/templates/languages/SWIFT.md +466 -466
  166. package/templates/languages/TYPESCRIPT.md +591 -591
  167. package/templates/languages/ZIG.md +265 -265
  168. package/templates/modules/ATLASSIAN.md +255 -255
  169. package/templates/modules/CONTEXT7.md +54 -54
  170. package/templates/modules/FIGMA.md +267 -267
  171. package/templates/modules/GITHUB_MCP.md +64 -64
  172. package/templates/modules/GRAFANA.md +328 -328
  173. package/templates/modules/MEMORY.md +126 -126
  174. package/templates/modules/NOTION.md +247 -247
  175. package/templates/modules/PLAYWRIGHT.md +90 -90
  176. package/templates/modules/RULEBOOK_MCP.md +156 -156
  177. package/templates/modules/SERENA.md +337 -337
  178. package/templates/modules/SUPABASE.md +223 -223
  179. package/templates/modules/SYNAP.md +69 -69
  180. package/templates/modules/VECTORIZER.md +63 -63
  181. package/templates/modules/sequential-thinking.md +42 -42
  182. package/templates/ralph/ralph-history.bat +4 -4
  183. package/templates/ralph/ralph-history.sh +5 -5
  184. package/templates/ralph/ralph-init.bat +5 -5
  185. package/templates/ralph/ralph-init.sh +5 -5
  186. package/templates/ralph/ralph-pause.bat +5 -5
  187. package/templates/ralph/ralph-pause.sh +5 -5
  188. package/templates/ralph/ralph-run.bat +5 -5
  189. package/templates/ralph/ralph-run.sh +5 -5
  190. package/templates/ralph/ralph-status.bat +4 -4
  191. package/templates/ralph/ralph-status.sh +5 -5
  192. package/templates/services/AZURE_BLOB.md +184 -184
  193. package/templates/services/CASSANDRA.md +239 -239
  194. package/templates/services/DATADOG.md +26 -26
  195. package/templates/services/DOCKER.md +124 -124
  196. package/templates/services/DOCKER_COMPOSE.md +168 -168
  197. package/templates/services/DYNAMODB.md +308 -308
  198. package/templates/services/ELASTICSEARCH.md +347 -347
  199. package/templates/services/GCS.md +178 -178
  200. package/templates/services/HELM.md +194 -194
  201. package/templates/services/INFLUXDB.md +265 -265
  202. package/templates/services/KAFKA.md +341 -341
  203. package/templates/services/KUBERNETES.md +208 -208
  204. package/templates/services/MARIADB.md +183 -183
  205. package/templates/services/MEMCACHED.md +242 -242
  206. package/templates/services/MINIO.md +201 -201
  207. package/templates/services/MONGODB.md +268 -268
  208. package/templates/services/MYSQL.md +358 -358
  209. package/templates/services/NEO4J.md +247 -247
  210. package/templates/services/OPENTELEMETRY.md +25 -25
  211. package/templates/services/ORACLE.md +290 -290
  212. package/templates/services/PINO.md +24 -24
  213. package/templates/services/POSTGRESQL.md +326 -326
  214. package/templates/services/PROMETHEUS.md +33 -33
  215. package/templates/services/RABBITMQ.md +286 -286
  216. package/templates/services/REDIS.md +292 -292
  217. package/templates/services/S3.md +298 -298
  218. package/templates/services/SENTRY.md +23 -23
  219. package/templates/services/SQLITE.md +294 -294
  220. package/templates/services/SQLSERVER.md +294 -294
  221. package/templates/services/WINSTON.md +30 -30
  222. package/templates/skills/cli/aider/SKILL.md +59 -59
  223. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  224. package/templates/skills/cli/auggie/SKILL.md +42 -42
  225. package/templates/skills/cli/claude/SKILL.md +42 -42
  226. package/templates/skills/cli/cline/SKILL.md +42 -42
  227. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  228. package/templates/skills/cli/codeium/SKILL.md +30 -30
  229. package/templates/skills/cli/codex/SKILL.md +31 -31
  230. package/templates/skills/cli/continue/SKILL.md +44 -44
  231. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  232. package/templates/skills/cli/factory/SKILL.md +28 -28
  233. package/templates/skills/cli/gemini/SKILL.md +45 -45
  234. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  235. package/templates/skills/cli/opencode/SKILL.md +28 -28
  236. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  237. package/templates/skills/core/dag/SKILL.md +314 -314
  238. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  239. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  240. package/templates/skills/core/rulebook/SKILL.md +176 -176
  241. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  242. package/templates/skills/dev/api-design/SKILL.md +15 -0
  243. package/templates/skills/dev/architect/SKILL.md +17 -0
  244. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  245. package/templates/skills/dev/db-design/SKILL.md +15 -0
  246. package/templates/skills/dev/debug/SKILL.md +16 -0
  247. package/templates/skills/dev/deploy/SKILL.md +17 -0
  248. package/templates/skills/dev/docs/SKILL.md +17 -0
  249. package/templates/skills/dev/migrate/SKILL.md +15 -0
  250. package/templates/skills/dev/perf/SKILL.md +17 -0
  251. package/templates/skills/dev/refactor/SKILL.md +17 -0
  252. package/templates/skills/dev/research/SKILL.md +14 -0
  253. package/templates/skills/dev/review/SKILL.md +18 -0
  254. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  255. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  256. package/templates/skills/frameworks/django/SKILL.md +93 -93
  257. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  258. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  259. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  260. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  261. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  262. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  263. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  264. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  265. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  266. package/templates/skills/frameworks/react/SKILL.md +48 -48
  267. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  268. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  269. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  270. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  271. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  272. package/templates/skills/ides/copilot/SKILL.md +47 -47
  273. package/templates/skills/ides/cursor/SKILL.md +53 -53
  274. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  275. package/templates/skills/ides/replit/SKILL.md +46 -46
  276. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  277. package/templates/skills/ides/vscode/SKILL.md +50 -50
  278. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  279. package/templates/skills/ides/zed/SKILL.md +42 -42
  280. package/templates/skills/languages/c/SKILL.md +343 -343
  281. package/templates/skills/languages/cpp/SKILL.md +753 -753
  282. package/templates/skills/languages/csharp/SKILL.md +427 -427
  283. package/templates/skills/languages/elixir/SKILL.md +464 -464
  284. package/templates/skills/languages/erlang/SKILL.md +371 -371
  285. package/templates/skills/languages/go/SKILL.md +655 -655
  286. package/templates/skills/languages/haskell/SKILL.md +187 -187
  287. package/templates/skills/languages/java/SKILL.md +617 -617
  288. package/templates/skills/languages/javascript/SKILL.md +641 -641
  289. package/templates/skills/languages/julia/SKILL.md +107 -107
  290. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  291. package/templates/skills/languages/lisp/SKILL.md +110 -110
  292. package/templates/skills/languages/lua/SKILL.md +84 -84
  293. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  294. package/templates/skills/languages/php/SKILL.md +426 -426
  295. package/templates/skills/languages/python/SKILL.md +692 -692
  296. package/templates/skills/languages/ruby/SKILL.md +431 -431
  297. package/templates/skills/languages/rust/SKILL.md +487 -487
  298. package/templates/skills/languages/sas/SKILL.md +83 -83
  299. package/templates/skills/languages/scala/SKILL.md +358 -358
  300. package/templates/skills/languages/solidity/SKILL.md +590 -590
  301. package/templates/skills/languages/sql/SKILL.md +147 -147
  302. package/templates/skills/languages/swift/SKILL.md +476 -476
  303. package/templates/skills/languages/typescript/SKILL.md +302 -302
  304. package/templates/skills/languages/zig/SKILL.md +275 -275
  305. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  306. package/templates/skills/modules/context7/SKILL.md +64 -64
  307. package/templates/skills/modules/figma/SKILL.md +277 -277
  308. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  309. package/templates/skills/modules/grafana/SKILL.md +338 -338
  310. package/templates/skills/modules/memory/SKILL.md +73 -73
  311. package/templates/skills/modules/notion/SKILL.md +257 -257
  312. package/templates/skills/modules/playwright/SKILL.md +100 -100
  313. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  314. package/templates/skills/modules/serena/SKILL.md +347 -347
  315. package/templates/skills/modules/supabase/SKILL.md +233 -233
  316. package/templates/skills/modules/synap/SKILL.md +79 -79
  317. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  318. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  319. package/templates/skills/services/cassandra/SKILL.md +249 -249
  320. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  321. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  322. package/templates/skills/services/gcs/SKILL.md +188 -188
  323. package/templates/skills/services/influxdb/SKILL.md +275 -275
  324. package/templates/skills/services/kafka/SKILL.md +351 -351
  325. package/templates/skills/services/mariadb/SKILL.md +193 -193
  326. package/templates/skills/services/memcached/SKILL.md +252 -252
  327. package/templates/skills/services/minio/SKILL.md +211 -211
  328. package/templates/skills/services/mongodb/SKILL.md +278 -278
  329. package/templates/skills/services/mysql/SKILL.md +368 -368
  330. package/templates/skills/services/neo4j/SKILL.md +257 -257
  331. package/templates/skills/services/oracle/SKILL.md +300 -300
  332. package/templates/skills/services/postgresql/SKILL.md +336 -336
  333. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  334. package/templates/skills/services/redis/SKILL.md +302 -302
  335. package/templates/skills/services/s3/SKILL.md +308 -308
  336. package/templates/skills/services/sqlite/SKILL.md +304 -304
  337. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  338. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  339. package/templates/skills/workflows/ralph/install.sh +87 -87
  340. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,655 +1,655 @@
1
- ---
2
- name: "Go"
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
- <!-- GO:START -->
12
- # Go 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
- gofmt -l . # Format check (should be empty)
21
- golangci-lint run # Linting
22
- go vet ./... # Static analysis
23
- go test ./... -v -race -coverprofile=coverage.out # Tests + race detection
24
- go tool cover -func=coverage.out # Coverage (95%+ required)
25
- go build ./... # Build verification
26
-
27
- # Security audit:
28
- go list -json -m all | nancy sleuth # Vulnerability scan
29
- go list -u -m all # Check outdated deps
30
- ```
31
-
32
- ## Go Version
33
-
34
- **CRITICAL**: Use Go 1.21+ for modern features and performance.
35
-
36
- - **Minimum Version**: Go 1.21+
37
- - **Recommended**: Go 1.22+
38
- - **Module System**: Go modules enabled
39
-
40
- ### Formatting
41
-
42
- - Use `gofmt` or `goimports` for code formatting
43
- - Standard Go formatting is non-negotiable
44
- - Format before committing: `gofmt -w .`
45
- - CI must check formatting: `gofmt -l . | wc -l` should be 0
46
-
47
- ### Linting
48
-
49
- - Use `golangci-lint` with recommended linters
50
- - Configuration in `.golangci.yml`
51
- - Must pass with no issues
52
- - Enable linters: govet, errcheck, staticcheck, gosimple, unused
53
-
54
- Example `.golangci.yml`:
55
- ```yaml
56
- linters:
57
- enable:
58
- - govet
59
- - errcheck
60
- - staticcheck
61
- - gosimple
62
- - unused
63
- - gosec
64
- - gocyclo
65
- - gofmt
66
- - goimports
67
-
68
- linters-settings:
69
- gocyclo:
70
- min-complexity: 15
71
- govet:
72
- check-shadowing: true
73
-
74
- issues:
75
- exclude-use-default: false
76
- ```
77
-
78
- ### Testing
79
-
80
- - **Framework**: Standard testing package
81
- - **Location**: `*_test.go` files in same package
82
- - **Coverage**: Must meet project threshold (default 95%)
83
- - **Table-Driven Tests**: Use for multiple test cases
84
- - **Subtests**: Use `t.Run()` for organized tests
85
-
86
- Example test structure:
87
- ```go
88
- package mypackage
89
-
90
- import (
91
- "testing"
92
- )
93
-
94
- func TestMyFunction(t *testing.T) {
95
- tests := []struct {
96
- name string
97
- input string
98
- want string
99
- wantErr bool
100
- }{
101
- {"valid input", "test", "TEST", false},
102
- {"empty input", "", "", true},
103
- }
104
-
105
- for _, tt := range tests {
106
- t.Run(tt.name, func(t *testing.T) {
107
- got, err := MyFunction(tt.input)
108
- if (err != nil) != tt.wantErr {
109
- t.Errorf("MyFunction() error = %v, wantErr %v", err, tt.wantErr)
110
- return
111
- }
112
- if got != tt.want {
113
- t.Errorf("MyFunction() = %v, want %v", got, tt.want)
114
- }
115
- })
116
- }
117
- }
118
- ```
119
-
120
- ### Test Categories: S2S and Slow Tests
121
-
122
- **CRITICAL**: Tests must be categorized based on execution time and dependencies.
123
-
124
- #### Test Time Limits
125
-
126
- - **Fast Tests**: Must complete in ≤ 10-20 seconds
127
- - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
128
- - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
129
-
130
- #### S2S (Server-to-Server) Tests
131
-
132
- **Tests that require active servers, databases, or external services must be isolated using build tags.**
133
-
134
- **Implementation**:
135
-
136
- 1. **Use build tags to isolate S2S tests**:
137
- ```go
138
- // +build s2s
139
-
140
- package mypackage
141
-
142
- import (
143
- "testing"
144
- "os"
145
- )
146
-
147
- func TestDatabaseConnection(t *testing.T) {
148
- // Requires active database server
149
- if os.Getenv("RUN_S2S_TESTS") == "" {
150
- t.Skip("S2S tests disabled. Set RUN_S2S_TESTS=1 to enable.")
151
- }
152
- db := connectToDatabase()
153
- // ... test implementation
154
- }
155
-
156
- func TestAPIIntegration(t *testing.T) {
157
- // Requires active API server
158
- if os.Getenv("RUN_S2S_TESTS") == "" {
159
- t.Skip("S2S tests disabled. Set RUN_S2S_TESTS=1 to enable.")
160
- }
161
- client := createAPIClient()
162
- // ... test implementation
163
- }
164
- ```
165
-
166
- 2. **Regular tests (without build tag)**:
167
- ```go
168
- // Regular fast test (always runs)
169
- package mypackage
170
-
171
- import "testing"
172
-
173
- func TestLocalComputation(t *testing.T) {
174
- // Fast test, no external dependencies
175
- result := computeLocally("input")
176
- if result != "expected" {
177
- t.Errorf("Expected 'expected', got %v", result)
178
- }
179
- }
180
- ```
181
-
182
- 3. **Run tests**:
183
- ```bash
184
- # Regular tests (excludes S2S)
185
- go test ./...
186
-
187
- # Include S2S tests (requires active servers)
188
- RUN_S2S_TESTS=1 go test -tags s2s ./...
189
-
190
- # Run only S2S tests
191
- RUN_S2S_TESTS=1 go test -tags s2s ./... -run TestDatabase
192
- ```
193
-
194
- #### Slow Tests
195
-
196
- **Tests that take > 10-20 seconds must be marked and run separately.**
197
-
198
- **Implementation**:
199
-
200
- 1. **Use build tags for slow tests**:
201
- ```go
202
- // +build slow
203
-
204
- package mypackage
205
-
206
- import (
207
- "testing"
208
- "time"
209
- )
210
-
211
- func TestHeavyComputation(t *testing.T) {
212
- // Takes 30+ seconds
213
- start := time.Now()
214
- result := processLargeDataset()
215
- duration := time.Since(start)
216
-
217
- if result == nil {
218
- t.Error("Expected result, got nil")
219
- }
220
- t.Logf("Test completed in %v", duration)
221
- }
222
-
223
- func TestLargeFileProcessing(t *testing.T) {
224
- // Processes large files, takes > 20 seconds
225
- result := processFile("large_file.dat")
226
- if !result.Success {
227
- t.Error("File processing failed")
228
- }
229
- }
230
- ```
231
-
232
- 2. **Alternative: Use environment variable**:
233
- ```go
234
- package mypackage
235
-
236
- import (
237
- "os"
238
- "testing"
239
- )
240
-
241
- func TestHeavyComputation(t *testing.T) {
242
- if os.Getenv("RUN_SLOW_TESTS") == "" {
243
- t.Skip("Slow tests disabled. Set RUN_SLOW_TESTS=1 to enable.")
244
- }
245
- // Heavy computation test
246
- }
247
- ```
248
-
249
- 3. **Run tests**:
250
- ```bash
251
- # Regular tests (excludes slow and S2S)
252
- go test ./...
253
-
254
- # Include slow tests
255
- RUN_SLOW_TESTS=1 go test -tags slow ./...
256
-
257
- # Run both S2S and slow tests
258
- RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 go test -tags "s2s slow" ./...
259
- ```
260
-
261
- 4. **Add Makefile targets**:
262
- ```makefile
263
- .PHONY: test test-s2s test-slow test-all
264
-
265
- test:
266
- go test ./...
267
-
268
- test-s2s:
269
- RUN_S2S_TESTS=1 go test -tags s2s ./...
270
-
271
- test-slow:
272
- RUN_SLOW_TESTS=1 go test -tags slow ./...
273
-
274
- test-all:
275
- RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 go test -tags "s2s slow" ./...
276
- ```
277
-
278
- 5. **Set timeouts in test functions**:
279
- ```go
280
- func TestWithTimeout(t *testing.T) {
281
- done := make(chan bool)
282
- go func() {
283
- // Long-running test
284
- result := heavyOperation()
285
- done <- (result != nil)
286
- }()
287
-
288
- select {
289
- case success := <-done:
290
- if !success {
291
- t.Error("Test failed")
292
- }
293
- case <-time.After(60 * time.Second):
294
- t.Fatal("Test timeout after 60 seconds")
295
- }
296
- }
297
- ```
298
-
299
- #### Best Practices
300
-
301
- - ✅ **Always run fast tests** in CI/CD by default
302
- - ✅ **Isolate S2S tests** - never run them in standard test suite
303
- - ✅ **Mark slow tests** - prevent CI/CD timeouts
304
- - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
305
- - ✅ **Use build tags** - `// +build s2s` and `// +build slow`
306
- - ✅ **Use environment variables** - Check `RUN_S2S_TESTS` and `RUN_SLOW_TESTS`
307
- - ✅ **Set timeouts** - Use `time.After()` or `context.WithTimeout()` for long-running tests
308
- - ✅ **Skip conditionally** - Use `t.Skip()` when services are unavailable
309
- - ❌ **Never mix** fast and slow/S2S tests in same test run
310
- - ❌ **Never require** external services for standard test suite
311
- - ❌ **Never exceed** 10-20 seconds for regular tests
312
-
313
- ## Dependency Management
314
-
315
- **CRITICAL**: Use Go modules for dependency management.
316
-
317
- ### go.mod and go.sum
318
-
319
- ```bash
320
- # Initialize module
321
- go mod init github.com/username/project
322
-
323
- # Add dependency
324
- go get github.com/package/name@latest
325
-
326
- # Update dependencies
327
- go get -u ./...
328
- go mod tidy
329
-
330
- # Verify dependencies
331
- go mod verify
332
- ```
333
-
334
- ### Dependency Guidelines
335
-
336
- 1. **Check for latest versions**:
337
- - Use Context7 MCP tool if available
338
- - Check pkg.go.dev for documentation
339
- - Review changelog for breaking changes
340
-
341
- 2. **Version Selection**:
342
- - ✅ Use latest stable versions
343
- - ✅ Pin to specific versions for reproducibility
344
- - ✅ Keep dependencies updated regularly
345
- - ✅ Use `go mod tidy` to remove unused
346
- - ❌ Don't use deprecated packages
347
- - ❌ Don't vendor unless necessary
348
-
349
- ## Error Handling
350
-
351
- - Always return errors, don't panic
352
- - Use custom error types with `fmt.Errorf`
353
- - Wrap errors with context: `fmt.Errorf("operation failed: %w", err)`
354
- - Check all errors, never ignore
355
- - Use `errors.Is()` and `errors.As()` for error checking
356
-
357
- Example:
358
- ```go
359
- package mypackage
360
-
361
- import (
362
- "errors"
363
- "fmt"
364
- )
365
-
366
- var (
367
- ErrInvalidInput = errors.New("invalid input")
368
- ErrNotFound = errors.New("not found")
369
- )
370
-
371
- func ProcessData(input string) (string, error) {
372
- if input == "" {
373
- return "", fmt.Errorf("process data: %w", ErrInvalidInput)
374
- }
375
-
376
- result, err := doSomething(input)
377
- if err != nil {
378
- return "", fmt.Errorf("failed to process: %w", err)
379
- }
380
-
381
- return result, nil
382
- }
383
- ```
384
-
385
- ## Documentation
386
-
387
- - **Package docs**: Use package comments
388
- - **Function docs**: Document all exported functions
389
- - **Examples**: Include in doc comments (will run as tests)
390
- - **Run godoc**: `go doc -all`
391
-
392
- Example:
393
- ```go
394
- // Package auth provides authentication and authorization utilities.
395
- //
396
- // This package implements JWT-based authentication following OAuth 2.0
397
- // standards. All functions are thread-safe.
398
- package auth
399
-
400
- // Authenticate verifies user credentials and returns a JWT token.
401
- //
402
- // The token is valid for 24 hours and includes the user's ID and roles.
403
- //
404
- // Example:
405
- //
406
- // token, err := Authenticate("user@example.com", "password")
407
- // if err != nil {
408
- // log.Fatal(err)
409
- // }
410
- // fmt.Println("Token:", token)
411
- //
412
- // Returns an error if credentials are invalid or database is unreachable.
413
- func Authenticate(email, password string) (string, error) {
414
- // Implementation
415
- return "", nil
416
- }
417
- ```
418
-
419
- ## Project Structure
420
-
421
- ```
422
- project/
423
- ├── go.mod # Module definition
424
- ├── go.sum # Dependency checksums (commit this)
425
- ├── README.md # Project overview (allowed in root)
426
- ├── CHANGELOG.md # Version history (allowed in root)
427
- ├── AGENTS.md # AI assistant rules (allowed in root)
428
- ├── LICENSE # Project license (allowed in root)
429
- ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
430
- ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
431
- ├── SECURITY.md # Security policy (allowed in root)
432
- ├── cmd/
433
- │ └── myapp/
434
- │ └── main.go # Application entry point
435
- ├── internal/ # Private packages
436
- │ └── module/
437
- │ ├── module.go
438
- │ └── module_test.go
439
- ├── pkg/ # Public packages
440
- │ └── api/
441
- │ ├── api.go
442
- │ └── api_test.go
443
- ├── tests/ # Integration tests
444
- └── docs/ # Documentation
445
- ```
446
-
447
- ## Concurrency
448
-
449
- - Use goroutines for concurrent operations
450
- - Use channels for communication
451
- - Use `sync.WaitGroup` for synchronization
452
- - Use context for cancellation and timeouts
453
- - Avoid shared memory, prefer channels
454
-
455
- Example:
456
- ```go
457
- func ProcessConcurrently(items []string) ([]Result, error) {
458
- ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
459
- defer cancel()
460
-
461
- results := make(chan Result, len(items))
462
- errors := make(chan error, len(items))
463
-
464
- var wg sync.WaitGroup
465
- for _, item := range items {
466
- wg.Add(1)
467
- go func(item string) {
468
- defer wg.Done()
469
-
470
- select {
471
- case <-ctx.Done():
472
- errors <- ctx.Err()
473
- return
474
- default:
475
- result, err := processItem(item)
476
- if err != nil {
477
- errors <- err
478
- return
479
- }
480
- results <- result
481
- }
482
- }(item)
483
- }
484
-
485
- wg.Wait()
486
- close(results)
487
- close(errors)
488
-
489
- // Collect results
490
- var finalResults []Result
491
- for r := range results {
492
- finalResults = append(finalResults, r)
493
- }
494
-
495
- // Check for errors
496
- for err := range errors {
497
- if err != nil {
498
- return nil, err
499
- }
500
- }
501
-
502
- return finalResults, nil
503
- }
504
- ```
505
-
506
- ## CI/CD Requirements
507
-
508
- Must include GitHub Actions workflows for:
509
-
510
- 1. **Testing** (`go-test.yml`):
511
- - Test on ubuntu-latest, windows-latest, macos-latest
512
- - Test on Go 1.21, 1.22
513
- - Upload coverage reports
514
-
515
- 2. **Linting** (`go-lint.yml`):
516
- - Format check: `gofmt -l .`
517
- - Lint: `golangci-lint run`
518
- - Vet: `go vet ./...`
519
-
520
- 3. **Build** (`go-build.yml`):
521
- - Build: `go build ./...`
522
- - Verify binaries work
523
-
524
- ## Module Publication
525
-
526
- ### Publishing Go Modules
527
-
528
- Go modules are published via Git tags and automatically indexed by pkg.go.dev.
529
-
530
- **Prerequisites:**
531
- 1. Public Git repository (GitHub, GitLab, etc.)
532
- 2. Proper go.mod configuration
533
- 3. Semantic versioning tags
534
-
535
- **go.mod Configuration:**
536
-
537
- ```go
538
- module github.com/your-org/your-module
539
-
540
- go 1.22
541
-
542
- require (
543
- github.com/example/dependency v1.2.3
544
- )
545
- ```
546
-
547
- **Publishing Workflow:**
548
-
549
- 1. Ensure go.mod is correct:
550
- ```bash
551
- go mod tidy
552
- go mod verify
553
- ```
554
-
555
- 2. Run quality checks:
556
- ```bash
557
- go fmt ./...
558
- go vet ./...
559
- golangci-lint run
560
- go test -v -race ./...
561
- ```
562
-
563
- 3. Create semantic version tag:
564
- ```bash
565
- git tag v1.0.0
566
- git push origin v1.0.0
567
- ```
568
-
569
- 4. pkg.go.dev automatically indexes the module
570
- 5. Verify at: `https://pkg.go.dev/github.com/your-org/your-module@v1.0.0`
571
-
572
- **Publishing Checklist:**
573
-
574
- - ✅ All tests passing (`go test ./...`)
575
- - ✅ No race conditions (`go test -race ./...`)
576
- - ✅ Code formatted (`go fmt ./...`)
577
- - ✅ No vet warnings (`go vet ./...`)
578
- - ✅ golangci-lint passes
579
- - ✅ go.mod is tidy (`go mod tidy`)
580
- - ✅ README.md with examples
581
- - ✅ LICENSE file present
582
- - ✅ Semantic version tag (v1.0.0)
583
- - ✅ CHANGELOG.md updated
584
-
585
- **Semantic Versioning:**
586
-
587
- Go uses semantic versioning strictly:
588
-
589
- - **v1.0.0** - First stable release
590
- - **v1.1.0** - New features (backwards compatible)
591
- - **v1.0.1** - Bug fixes
592
- - **v2.0.0** - Breaking changes (requires /v2 in module path)
593
-
594
- **Major Version Updates (v2+):**
595
-
596
- For v2 and above, update module path:
597
-
598
- ```go
599
- // go.mod
600
- module github.com/your-org/your-module/v2
601
-
602
- go 1.22
603
- ```
604
-
605
- **Module Documentation:**
606
-
607
- Write godoc-compatible comments:
608
-
609
- ```go
610
- // Package yourmodule provides functionality for X, Y, and Z.
611
- //
612
- // Basic usage:
613
- //
614
- // import "github.com/your-org/your-module"
615
- //
616
- // result, err := yourmodule.Process("input")
617
- // if err != nil {
618
- // log.Fatal(err)
619
- // }
620
- package yourmodule
621
-
622
- // Process handles the input and returns a result.
623
- //
624
- // Example:
625
- //
626
- // result, err := Process("hello")
627
- // if err != nil {
628
- // return err
629
- // }
630
- // fmt.Println(result)
631
- func Process(input string) (string, error) {
632
- // Implementation
633
- }
634
- ```
635
-
636
- **GOPROXY:**
637
-
638
- Go modules are automatically cached in public proxies:
639
- - https://proxy.golang.org (default)
640
- - https://goproxy.io
641
- - https://goproxy.cn
642
-
643
- No manual publication needed!
644
-
645
- **Retraction:**
646
-
647
- To retract a published version:
648
-
649
- ```go
650
- // go.mod
651
- retract v1.0.5 // Critical bug in processing
652
- ```
653
-
654
- <!-- GO:END -->
655
-
1
+ ---
2
+ name: "Go"
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
+ <!-- GO:START -->
12
+ # Go 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
+ gofmt -l . # Format check (should be empty)
21
+ golangci-lint run # Linting
22
+ go vet ./... # Static analysis
23
+ go test ./... -v -race -coverprofile=coverage.out # Tests + race detection
24
+ go tool cover -func=coverage.out # Coverage (95%+ required)
25
+ go build ./... # Build verification
26
+
27
+ # Security audit:
28
+ go list -json -m all | nancy sleuth # Vulnerability scan
29
+ go list -u -m all # Check outdated deps
30
+ ```
31
+
32
+ ## Go Version
33
+
34
+ **CRITICAL**: Use Go 1.21+ for modern features and performance.
35
+
36
+ - **Minimum Version**: Go 1.21+
37
+ - **Recommended**: Go 1.22+
38
+ - **Module System**: Go modules enabled
39
+
40
+ ### Formatting
41
+
42
+ - Use `gofmt` or `goimports` for code formatting
43
+ - Standard Go formatting is non-negotiable
44
+ - Format before committing: `gofmt -w .`
45
+ - CI must check formatting: `gofmt -l . | wc -l` should be 0
46
+
47
+ ### Linting
48
+
49
+ - Use `golangci-lint` with recommended linters
50
+ - Configuration in `.golangci.yml`
51
+ - Must pass with no issues
52
+ - Enable linters: govet, errcheck, staticcheck, gosimple, unused
53
+
54
+ Example `.golangci.yml`:
55
+ ```yaml
56
+ linters:
57
+ enable:
58
+ - govet
59
+ - errcheck
60
+ - staticcheck
61
+ - gosimple
62
+ - unused
63
+ - gosec
64
+ - gocyclo
65
+ - gofmt
66
+ - goimports
67
+
68
+ linters-settings:
69
+ gocyclo:
70
+ min-complexity: 15
71
+ govet:
72
+ check-shadowing: true
73
+
74
+ issues:
75
+ exclude-use-default: false
76
+ ```
77
+
78
+ ### Testing
79
+
80
+ - **Framework**: Standard testing package
81
+ - **Location**: `*_test.go` files in same package
82
+ - **Coverage**: Must meet project threshold (default 95%)
83
+ - **Table-Driven Tests**: Use for multiple test cases
84
+ - **Subtests**: Use `t.Run()` for organized tests
85
+
86
+ Example test structure:
87
+ ```go
88
+ package mypackage
89
+
90
+ import (
91
+ "testing"
92
+ )
93
+
94
+ func TestMyFunction(t *testing.T) {
95
+ tests := []struct {
96
+ name string
97
+ input string
98
+ want string
99
+ wantErr bool
100
+ }{
101
+ {"valid input", "test", "TEST", false},
102
+ {"empty input", "", "", true},
103
+ }
104
+
105
+ for _, tt := range tests {
106
+ t.Run(tt.name, func(t *testing.T) {
107
+ got, err := MyFunction(tt.input)
108
+ if (err != nil) != tt.wantErr {
109
+ t.Errorf("MyFunction() error = %v, wantErr %v", err, tt.wantErr)
110
+ return
111
+ }
112
+ if got != tt.want {
113
+ t.Errorf("MyFunction() = %v, want %v", got, tt.want)
114
+ }
115
+ })
116
+ }
117
+ }
118
+ ```
119
+
120
+ ### Test Categories: S2S and Slow Tests
121
+
122
+ **CRITICAL**: Tests must be categorized based on execution time and dependencies.
123
+
124
+ #### Test Time Limits
125
+
126
+ - **Fast Tests**: Must complete in ≤ 10-20 seconds
127
+ - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
128
+ - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
129
+
130
+ #### S2S (Server-to-Server) Tests
131
+
132
+ **Tests that require active servers, databases, or external services must be isolated using build tags.**
133
+
134
+ **Implementation**:
135
+
136
+ 1. **Use build tags to isolate S2S tests**:
137
+ ```go
138
+ // +build s2s
139
+
140
+ package mypackage
141
+
142
+ import (
143
+ "testing"
144
+ "os"
145
+ )
146
+
147
+ func TestDatabaseConnection(t *testing.T) {
148
+ // Requires active database server
149
+ if os.Getenv("RUN_S2S_TESTS") == "" {
150
+ t.Skip("S2S tests disabled. Set RUN_S2S_TESTS=1 to enable.")
151
+ }
152
+ db := connectToDatabase()
153
+ // ... test implementation
154
+ }
155
+
156
+ func TestAPIIntegration(t *testing.T) {
157
+ // Requires active API server
158
+ if os.Getenv("RUN_S2S_TESTS") == "" {
159
+ t.Skip("S2S tests disabled. Set RUN_S2S_TESTS=1 to enable.")
160
+ }
161
+ client := createAPIClient()
162
+ // ... test implementation
163
+ }
164
+ ```
165
+
166
+ 2. **Regular tests (without build tag)**:
167
+ ```go
168
+ // Regular fast test (always runs)
169
+ package mypackage
170
+
171
+ import "testing"
172
+
173
+ func TestLocalComputation(t *testing.T) {
174
+ // Fast test, no external dependencies
175
+ result := computeLocally("input")
176
+ if result != "expected" {
177
+ t.Errorf("Expected 'expected', got %v", result)
178
+ }
179
+ }
180
+ ```
181
+
182
+ 3. **Run tests**:
183
+ ```bash
184
+ # Regular tests (excludes S2S)
185
+ go test ./...
186
+
187
+ # Include S2S tests (requires active servers)
188
+ RUN_S2S_TESTS=1 go test -tags s2s ./...
189
+
190
+ # Run only S2S tests
191
+ RUN_S2S_TESTS=1 go test -tags s2s ./... -run TestDatabase
192
+ ```
193
+
194
+ #### Slow Tests
195
+
196
+ **Tests that take > 10-20 seconds must be marked and run separately.**
197
+
198
+ **Implementation**:
199
+
200
+ 1. **Use build tags for slow tests**:
201
+ ```go
202
+ // +build slow
203
+
204
+ package mypackage
205
+
206
+ import (
207
+ "testing"
208
+ "time"
209
+ )
210
+
211
+ func TestHeavyComputation(t *testing.T) {
212
+ // Takes 30+ seconds
213
+ start := time.Now()
214
+ result := processLargeDataset()
215
+ duration := time.Since(start)
216
+
217
+ if result == nil {
218
+ t.Error("Expected result, got nil")
219
+ }
220
+ t.Logf("Test completed in %v", duration)
221
+ }
222
+
223
+ func TestLargeFileProcessing(t *testing.T) {
224
+ // Processes large files, takes > 20 seconds
225
+ result := processFile("large_file.dat")
226
+ if !result.Success {
227
+ t.Error("File processing failed")
228
+ }
229
+ }
230
+ ```
231
+
232
+ 2. **Alternative: Use environment variable**:
233
+ ```go
234
+ package mypackage
235
+
236
+ import (
237
+ "os"
238
+ "testing"
239
+ )
240
+
241
+ func TestHeavyComputation(t *testing.T) {
242
+ if os.Getenv("RUN_SLOW_TESTS") == "" {
243
+ t.Skip("Slow tests disabled. Set RUN_SLOW_TESTS=1 to enable.")
244
+ }
245
+ // Heavy computation test
246
+ }
247
+ ```
248
+
249
+ 3. **Run tests**:
250
+ ```bash
251
+ # Regular tests (excludes slow and S2S)
252
+ go test ./...
253
+
254
+ # Include slow tests
255
+ RUN_SLOW_TESTS=1 go test -tags slow ./...
256
+
257
+ # Run both S2S and slow tests
258
+ RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 go test -tags "s2s slow" ./...
259
+ ```
260
+
261
+ 4. **Add Makefile targets**:
262
+ ```makefile
263
+ .PHONY: test test-s2s test-slow test-all
264
+
265
+ test:
266
+ go test ./...
267
+
268
+ test-s2s:
269
+ RUN_S2S_TESTS=1 go test -tags s2s ./...
270
+
271
+ test-slow:
272
+ RUN_SLOW_TESTS=1 go test -tags slow ./...
273
+
274
+ test-all:
275
+ RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 go test -tags "s2s slow" ./...
276
+ ```
277
+
278
+ 5. **Set timeouts in test functions**:
279
+ ```go
280
+ func TestWithTimeout(t *testing.T) {
281
+ done := make(chan bool)
282
+ go func() {
283
+ // Long-running test
284
+ result := heavyOperation()
285
+ done <- (result != nil)
286
+ }()
287
+
288
+ select {
289
+ case success := <-done:
290
+ if !success {
291
+ t.Error("Test failed")
292
+ }
293
+ case <-time.After(60 * time.Second):
294
+ t.Fatal("Test timeout after 60 seconds")
295
+ }
296
+ }
297
+ ```
298
+
299
+ #### Best Practices
300
+
301
+ - ✅ **Always run fast tests** in CI/CD by default
302
+ - ✅ **Isolate S2S tests** - never run them in standard test suite
303
+ - ✅ **Mark slow tests** - prevent CI/CD timeouts
304
+ - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
305
+ - ✅ **Use build tags** - `// +build s2s` and `// +build slow`
306
+ - ✅ **Use environment variables** - Check `RUN_S2S_TESTS` and `RUN_SLOW_TESTS`
307
+ - ✅ **Set timeouts** - Use `time.After()` or `context.WithTimeout()` for long-running tests
308
+ - ✅ **Skip conditionally** - Use `t.Skip()` when services are unavailable
309
+ - ❌ **Never mix** fast and slow/S2S tests in same test run
310
+ - ❌ **Never require** external services for standard test suite
311
+ - ❌ **Never exceed** 10-20 seconds for regular tests
312
+
313
+ ## Dependency Management
314
+
315
+ **CRITICAL**: Use Go modules for dependency management.
316
+
317
+ ### go.mod and go.sum
318
+
319
+ ```bash
320
+ # Initialize module
321
+ go mod init github.com/username/project
322
+
323
+ # Add dependency
324
+ go get github.com/package/name@latest
325
+
326
+ # Update dependencies
327
+ go get -u ./...
328
+ go mod tidy
329
+
330
+ # Verify dependencies
331
+ go mod verify
332
+ ```
333
+
334
+ ### Dependency Guidelines
335
+
336
+ 1. **Check for latest versions**:
337
+ - Use Context7 MCP tool if available
338
+ - Check pkg.go.dev for documentation
339
+ - Review changelog for breaking changes
340
+
341
+ 2. **Version Selection**:
342
+ - ✅ Use latest stable versions
343
+ - ✅ Pin to specific versions for reproducibility
344
+ - ✅ Keep dependencies updated regularly
345
+ - ✅ Use `go mod tidy` to remove unused
346
+ - ❌ Don't use deprecated packages
347
+ - ❌ Don't vendor unless necessary
348
+
349
+ ## Error Handling
350
+
351
+ - Always return errors, don't panic
352
+ - Use custom error types with `fmt.Errorf`
353
+ - Wrap errors with context: `fmt.Errorf("operation failed: %w", err)`
354
+ - Check all errors, never ignore
355
+ - Use `errors.Is()` and `errors.As()` for error checking
356
+
357
+ Example:
358
+ ```go
359
+ package mypackage
360
+
361
+ import (
362
+ "errors"
363
+ "fmt"
364
+ )
365
+
366
+ var (
367
+ ErrInvalidInput = errors.New("invalid input")
368
+ ErrNotFound = errors.New("not found")
369
+ )
370
+
371
+ func ProcessData(input string) (string, error) {
372
+ if input == "" {
373
+ return "", fmt.Errorf("process data: %w", ErrInvalidInput)
374
+ }
375
+
376
+ result, err := doSomething(input)
377
+ if err != nil {
378
+ return "", fmt.Errorf("failed to process: %w", err)
379
+ }
380
+
381
+ return result, nil
382
+ }
383
+ ```
384
+
385
+ ## Documentation
386
+
387
+ - **Package docs**: Use package comments
388
+ - **Function docs**: Document all exported functions
389
+ - **Examples**: Include in doc comments (will run as tests)
390
+ - **Run godoc**: `go doc -all`
391
+
392
+ Example:
393
+ ```go
394
+ // Package auth provides authentication and authorization utilities.
395
+ //
396
+ // This package implements JWT-based authentication following OAuth 2.0
397
+ // standards. All functions are thread-safe.
398
+ package auth
399
+
400
+ // Authenticate verifies user credentials and returns a JWT token.
401
+ //
402
+ // The token is valid for 24 hours and includes the user's ID and roles.
403
+ //
404
+ // Example:
405
+ //
406
+ // token, err := Authenticate("user@example.com", "password")
407
+ // if err != nil {
408
+ // log.Fatal(err)
409
+ // }
410
+ // fmt.Println("Token:", token)
411
+ //
412
+ // Returns an error if credentials are invalid or database is unreachable.
413
+ func Authenticate(email, password string) (string, error) {
414
+ // Implementation
415
+ return "", nil
416
+ }
417
+ ```
418
+
419
+ ## Project Structure
420
+
421
+ ```
422
+ project/
423
+ ├── go.mod # Module definition
424
+ ├── go.sum # Dependency checksums (commit this)
425
+ ├── README.md # Project overview (allowed in root)
426
+ ├── CHANGELOG.md # Version history (allowed in root)
427
+ ├── AGENTS.md # AI assistant rules (allowed in root)
428
+ ├── LICENSE # Project license (allowed in root)
429
+ ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
430
+ ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
431
+ ├── SECURITY.md # Security policy (allowed in root)
432
+ ├── cmd/
433
+ │ └── myapp/
434
+ │ └── main.go # Application entry point
435
+ ├── internal/ # Private packages
436
+ │ └── module/
437
+ │ ├── module.go
438
+ │ └── module_test.go
439
+ ├── pkg/ # Public packages
440
+ │ └── api/
441
+ │ ├── api.go
442
+ │ └── api_test.go
443
+ ├── tests/ # Integration tests
444
+ └── docs/ # Documentation
445
+ ```
446
+
447
+ ## Concurrency
448
+
449
+ - Use goroutines for concurrent operations
450
+ - Use channels for communication
451
+ - Use `sync.WaitGroup` for synchronization
452
+ - Use context for cancellation and timeouts
453
+ - Avoid shared memory, prefer channels
454
+
455
+ Example:
456
+ ```go
457
+ func ProcessConcurrently(items []string) ([]Result, error) {
458
+ ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
459
+ defer cancel()
460
+
461
+ results := make(chan Result, len(items))
462
+ errors := make(chan error, len(items))
463
+
464
+ var wg sync.WaitGroup
465
+ for _, item := range items {
466
+ wg.Add(1)
467
+ go func(item string) {
468
+ defer wg.Done()
469
+
470
+ select {
471
+ case <-ctx.Done():
472
+ errors <- ctx.Err()
473
+ return
474
+ default:
475
+ result, err := processItem(item)
476
+ if err != nil {
477
+ errors <- err
478
+ return
479
+ }
480
+ results <- result
481
+ }
482
+ }(item)
483
+ }
484
+
485
+ wg.Wait()
486
+ close(results)
487
+ close(errors)
488
+
489
+ // Collect results
490
+ var finalResults []Result
491
+ for r := range results {
492
+ finalResults = append(finalResults, r)
493
+ }
494
+
495
+ // Check for errors
496
+ for err := range errors {
497
+ if err != nil {
498
+ return nil, err
499
+ }
500
+ }
501
+
502
+ return finalResults, nil
503
+ }
504
+ ```
505
+
506
+ ## CI/CD Requirements
507
+
508
+ Must include GitHub Actions workflows for:
509
+
510
+ 1. **Testing** (`go-test.yml`):
511
+ - Test on ubuntu-latest, windows-latest, macos-latest
512
+ - Test on Go 1.21, 1.22
513
+ - Upload coverage reports
514
+
515
+ 2. **Linting** (`go-lint.yml`):
516
+ - Format check: `gofmt -l .`
517
+ - Lint: `golangci-lint run`
518
+ - Vet: `go vet ./...`
519
+
520
+ 3. **Build** (`go-build.yml`):
521
+ - Build: `go build ./...`
522
+ - Verify binaries work
523
+
524
+ ## Module Publication
525
+
526
+ ### Publishing Go Modules
527
+
528
+ Go modules are published via Git tags and automatically indexed by pkg.go.dev.
529
+
530
+ **Prerequisites:**
531
+ 1. Public Git repository (GitHub, GitLab, etc.)
532
+ 2. Proper go.mod configuration
533
+ 3. Semantic versioning tags
534
+
535
+ **go.mod Configuration:**
536
+
537
+ ```go
538
+ module github.com/your-org/your-module
539
+
540
+ go 1.22
541
+
542
+ require (
543
+ github.com/example/dependency v1.2.3
544
+ )
545
+ ```
546
+
547
+ **Publishing Workflow:**
548
+
549
+ 1. Ensure go.mod is correct:
550
+ ```bash
551
+ go mod tidy
552
+ go mod verify
553
+ ```
554
+
555
+ 2. Run quality checks:
556
+ ```bash
557
+ go fmt ./...
558
+ go vet ./...
559
+ golangci-lint run
560
+ go test -v -race ./...
561
+ ```
562
+
563
+ 3. Create semantic version tag:
564
+ ```bash
565
+ git tag v1.0.0
566
+ git push origin v1.0.0
567
+ ```
568
+
569
+ 4. pkg.go.dev automatically indexes the module
570
+ 5. Verify at: `https://pkg.go.dev/github.com/your-org/your-module@v1.0.0`
571
+
572
+ **Publishing Checklist:**
573
+
574
+ - ✅ All tests passing (`go test ./...`)
575
+ - ✅ No race conditions (`go test -race ./...`)
576
+ - ✅ Code formatted (`go fmt ./...`)
577
+ - ✅ No vet warnings (`go vet ./...`)
578
+ - ✅ golangci-lint passes
579
+ - ✅ go.mod is tidy (`go mod tidy`)
580
+ - ✅ README.md with examples
581
+ - ✅ LICENSE file present
582
+ - ✅ Semantic version tag (v1.0.0)
583
+ - ✅ CHANGELOG.md updated
584
+
585
+ **Semantic Versioning:**
586
+
587
+ Go uses semantic versioning strictly:
588
+
589
+ - **v1.0.0** - First stable release
590
+ - **v1.1.0** - New features (backwards compatible)
591
+ - **v1.0.1** - Bug fixes
592
+ - **v2.0.0** - Breaking changes (requires /v2 in module path)
593
+
594
+ **Major Version Updates (v2+):**
595
+
596
+ For v2 and above, update module path:
597
+
598
+ ```go
599
+ // go.mod
600
+ module github.com/your-org/your-module/v2
601
+
602
+ go 1.22
603
+ ```
604
+
605
+ **Module Documentation:**
606
+
607
+ Write godoc-compatible comments:
608
+
609
+ ```go
610
+ // Package yourmodule provides functionality for X, Y, and Z.
611
+ //
612
+ // Basic usage:
613
+ //
614
+ // import "github.com/your-org/your-module"
615
+ //
616
+ // result, err := yourmodule.Process("input")
617
+ // if err != nil {
618
+ // log.Fatal(err)
619
+ // }
620
+ package yourmodule
621
+
622
+ // Process handles the input and returns a result.
623
+ //
624
+ // Example:
625
+ //
626
+ // result, err := Process("hello")
627
+ // if err != nil {
628
+ // return err
629
+ // }
630
+ // fmt.Println(result)
631
+ func Process(input string) (string, error) {
632
+ // Implementation
633
+ }
634
+ ```
635
+
636
+ **GOPROXY:**
637
+
638
+ Go modules are automatically cached in public proxies:
639
+ - https://proxy.golang.org (default)
640
+ - https://goproxy.io
641
+ - https://goproxy.cn
642
+
643
+ No manual publication needed!
644
+
645
+ **Retraction:**
646
+
647
+ To retract a published version:
648
+
649
+ ```go
650
+ // go.mod
651
+ retract v1.0.5 // Critical bug in processing
652
+ ```
653
+
654
+ <!-- GO:END -->
655
+