@zimezone/z-command 1.1.1 → 1.1.2

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 (282) hide show
  1. package/README.md +13 -1
  2. package/dist/commands/init.d.ts.map +1 -1
  3. package/dist/commands/init.js +34 -9
  4. package/dist/commands/init.js.map +1 -1
  5. package/package.json +8 -3
  6. package/templates.zip +0 -0
  7. package/templates/agents/accessibility-expert.agent.md +0 -56
  8. package/templates/agents/ai-engineer.agent.md +0 -61
  9. package/templates/agents/angular-architect.agent.md +0 -49
  10. package/templates/agents/api-designer.agent.md +0 -40
  11. package/templates/agents/api-documenter.agent.md +0 -161
  12. package/templates/agents/architect-review.agent.md +0 -146
  13. package/templates/agents/arm-cortex-expert.agent.md +0 -288
  14. package/templates/agents/azure-infra-engineer.agent.md +0 -57
  15. package/templates/agents/backend-architect.agent.md +0 -309
  16. package/templates/agents/backend-developer.agent.md +0 -61
  17. package/templates/agents/backend-security-coder.agent.md +0 -152
  18. package/templates/agents/bash-pro.agent.md +0 -285
  19. package/templates/agents/blockchain-developer.agent.md +0 -57
  20. package/templates/agents/build-engineer.agent.md +0 -56
  21. package/templates/agents/business-analyst.agent.md +0 -47
  22. package/templates/agents/c-pro.agent.md +0 -35
  23. package/templates/agents/c4-code.agent.md +0 -320
  24. package/templates/agents/c4-component.agent.md +0 -227
  25. package/templates/agents/c4-container.agent.md +0 -248
  26. package/templates/agents/c4-context.agent.md +0 -235
  27. package/templates/agents/cli-developer.agent.md +0 -57
  28. package/templates/agents/cloud-architect.agent.md +0 -56
  29. package/templates/agents/code-architect.agent.md +0 -63
  30. package/templates/agents/code-reviewer.agent.md +0 -49
  31. package/templates/agents/competitive-analyst.agent.md +0 -48
  32. package/templates/agents/conductor-validator.agent.md +0 -245
  33. package/templates/agents/context-manager.agent.md +0 -55
  34. package/templates/agents/cpp-pro.agent.md +0 -59
  35. package/templates/agents/csharp-developer.agent.md +0 -57
  36. package/templates/agents/csharp-pro.agent.md +0 -38
  37. package/templates/agents/customer-support.agent.md +0 -148
  38. package/templates/agents/data-engineer.agent.md +0 -55
  39. package/templates/agents/data-researcher.agent.md +0 -55
  40. package/templates/agents/data-scientist.agent.md +0 -56
  41. package/templates/agents/database-admin.agent.md +0 -142
  42. package/templates/agents/database-administrator.agent.md +0 -50
  43. package/templates/agents/database-architect.agent.md +0 -238
  44. package/templates/agents/database-optimizer.agent.md +0 -144
  45. package/templates/agents/debugger.agent.md +0 -30
  46. package/templates/agents/deployment-engineer.agent.md +0 -0
  47. package/templates/agents/devops-engineer.agent.md +0 -59
  48. package/templates/agents/devops-troubleshooter.agent.md +0 -138
  49. package/templates/agents/django-developer.agent.md +0 -50
  50. package/templates/agents/django-pro.agent.md +0 -159
  51. package/templates/agents/docs-architect.agent.md +0 -77
  52. package/templates/agents/documentation-engineer.agent.md +0 -57
  53. package/templates/agents/dotnet-architect.agent.md +0 -175
  54. package/templates/agents/dx-optimizer.agent.md +0 -63
  55. package/templates/agents/electron-pro.agent.md +0 -56
  56. package/templates/agents/elixir-pro.agent.md +0 -38
  57. package/templates/agents/embedded-systems.agent.md +0 -55
  58. package/templates/agents/error-detective.agent.md +0 -32
  59. package/templates/agents/event-sourcing-architect.agent.md +0 -42
  60. package/templates/agents/fastapi-pro.agent.md +0 -171
  61. package/templates/agents/fintech-engineer.agent.md +0 -57
  62. package/templates/agents/firmware-analyst.agent.md +0 -330
  63. package/templates/agents/flutter-expert.agent.md +0 -50
  64. package/templates/agents/frontend-developer.agent.md +0 -59
  65. package/templates/agents/frontend-security-coder.agent.md +0 -149
  66. package/templates/agents/fullstack-developer.agent.md +0 -46
  67. package/templates/agents/git-workflow-manager.agent.md +0 -57
  68. package/templates/agents/golang-pro.agent.md +0 -50
  69. package/templates/agents/graphql-architect.agent.md +0 -48
  70. package/templates/agents/haskell-pro.agent.md +0 -37
  71. package/templates/agents/hr-pro.agent.md +0 -105
  72. package/templates/agents/incident-responder.agent.md +0 -190
  73. package/templates/agents/ios-developer.agent.md +0 -198
  74. package/templates/agents/iot-engineer.agent.md +0 -56
  75. package/templates/agents/java-architect.agent.md +0 -48
  76. package/templates/agents/java-pro.agent.md +0 -156
  77. package/templates/agents/javascript-pro.agent.md +0 -35
  78. package/templates/agents/julia-pro.agent.md +0 -187
  79. package/templates/agents/kotlin-specialist.agent.md +0 -50
  80. package/templates/agents/laravel-specialist.agent.md +0 -50
  81. package/templates/agents/legacy-modernizer.agent.md +0 -56
  82. package/templates/agents/legal-advisor.agent.md +0 -49
  83. package/templates/agents/llm-architect.agent.md +0 -58
  84. package/templates/agents/malware-analyst.agent.md +0 -272
  85. package/templates/agents/mcp-developer.agent.md +0 -54
  86. package/templates/agents/mermaid-expert.agent.md +0 -39
  87. package/templates/agents/microservices-architect.agent.md +0 -47
  88. package/templates/agents/minecraft-bukkit-pro.agent.md +0 -104
  89. package/templates/agents/ml-engineer.agent.md +0 -56
  90. package/templates/agents/mlops-engineer.agent.md +0 -56
  91. package/templates/agents/mobile-developer.agent.md +0 -45
  92. package/templates/agents/mobile-security-coder.agent.md +0 -163
  93. package/templates/agents/monorepo-architect.agent.md +0 -44
  94. package/templates/agents/multi-agent-coordinator.agent.md +0 -55
  95. package/templates/agents/network-engineer.agent.md +0 -57
  96. package/templates/agents/nextjs-developer.agent.md +0 -48
  97. package/templates/agents/nlp-engineer.agent.md +0 -58
  98. package/templates/agents/observability-engineer.agent.md +0 -228
  99. package/templates/agents/payment-integration.agent.md +0 -56
  100. package/templates/agents/performance-engineer.agent.md +0 -167
  101. package/templates/agents/performance-optimizer.agent.md +0 -57
  102. package/templates/agents/php-pro.agent.md +0 -43
  103. package/templates/agents/platform-engineer.agent.md +0 -57
  104. package/templates/agents/posix-shell-pro.agent.md +0 -284
  105. package/templates/agents/postgres-pro.agent.md +0 -58
  106. package/templates/agents/product-manager.agent.md +0 -55
  107. package/templates/agents/project-manager.agent.md +0 -57
  108. package/templates/agents/prompt-engineer.agent.md +0 -58
  109. package/templates/agents/python-pro.agent.md +0 -48
  110. package/templates/agents/quant-analyst.agent.md +0 -32
  111. package/templates/agents/rails-expert.agent.md +0 -50
  112. package/templates/agents/react-specialist.agent.md +0 -49
  113. package/templates/agents/refactoring-specialist.agent.md +0 -56
  114. package/templates/agents/reference-builder.agent.md +0 -167
  115. package/templates/agents/research-analyst.agent.md +0 -63
  116. package/templates/agents/reverse-engineer.agent.md +0 -202
  117. package/templates/agents/risk-manager.agent.md +0 -41
  118. package/templates/agents/ruby-pro.agent.md +0 -35
  119. package/templates/agents/rust-pro.agent.md +0 -156
  120. package/templates/agents/sales-automator.agent.md +0 -35
  121. package/templates/agents/scala-pro.agent.md +0 -60
  122. package/templates/agents/scrum-master.agent.md +0 -54
  123. package/templates/agents/search-specialist.agent.md +0 -59
  124. package/templates/agents/security-analyst.agent.md +0 -57
  125. package/templates/agents/security-auditor.agent.md +0 -138
  126. package/templates/agents/security-engineer.agent.md +0 -57
  127. package/templates/agents/seo-authority-builder.agent.md +0 -116
  128. package/templates/agents/seo-cannibalization-detector.agent.md +0 -103
  129. package/templates/agents/seo-content-auditor.agent.md +0 -63
  130. package/templates/agents/seo-content-planner.agent.md +0 -88
  131. package/templates/agents/seo-content-refresher.agent.md +0 -98
  132. package/templates/agents/seo-content-writer.agent.md +0 -76
  133. package/templates/agents/seo-keyword-strategist.agent.md +0 -75
  134. package/templates/agents/seo-meta-optimizer.agent.md +0 -72
  135. package/templates/agents/seo-snippet-hunter.agent.md +0 -94
  136. package/templates/agents/seo-specialist.agent.md +0 -57
  137. package/templates/agents/seo-structure-architect.agent.md +0 -88
  138. package/templates/agents/service-mesh-expert.agent.md +0 -41
  139. package/templates/agents/sql-pro.agent.md +0 -146
  140. package/templates/agents/sre-engineer.agent.md +0 -58
  141. package/templates/agents/swift-expert.agent.md +0 -49
  142. package/templates/agents/task-distributor.agent.md +0 -47
  143. package/templates/agents/tdd-orchestrator.agent.md +0 -183
  144. package/templates/agents/technical-writer.agent.md +0 -48
  145. package/templates/agents/temporal-python-pro.agent.md +0 -349
  146. package/templates/agents/terraform-engineer.agent.md +0 -57
  147. package/templates/agents/terraform-specialist.agent.md +0 -137
  148. package/templates/agents/test-automator.agent.md +0 -203
  149. package/templates/agents/test-engineer.agent.md +0 -55
  150. package/templates/agents/threat-modeling-expert.agent.md +0 -44
  151. package/templates/agents/trend-analyst.agent.md +0 -47
  152. package/templates/agents/tutorial-engineer.agent.md +0 -118
  153. package/templates/agents/typescript-pro.agent.md +0 -48
  154. package/templates/agents/ui-designer.agent.md +0 -48
  155. package/templates/agents/ui-ux-designer.agent.md +0 -188
  156. package/templates/agents/ui-visual-validator.agent.md +0 -192
  157. package/templates/agents/ux-researcher.agent.md +0 -48
  158. package/templates/agents/vector-database-engineer.agent.md +0 -43
  159. package/templates/agents/vue-expert.agent.md +0 -48
  160. package/templates/agents/websocket-engineer.agent.md +0 -49
  161. package/templates/agents/workflow-orchestrator.agent.md +0 -48
  162. package/templates/skills/angular-migration/SKILL.md +0 -410
  163. package/templates/skills/api-design-principles/SKILL.md +0 -528
  164. package/templates/skills/api-design-principles/assets/api-design-checklist.md +0 -155
  165. package/templates/skills/api-design-principles/assets/rest-api-template.py +0 -182
  166. package/templates/skills/api-design-principles/references/graphql-schema-design.md +0 -583
  167. package/templates/skills/api-design-principles/references/rest-best-practices.md +0 -408
  168. package/templates/skills/architecture-decision-records/SKILL.md +0 -428
  169. package/templates/skills/architecture-patterns/SKILL.md +0 -494
  170. package/templates/skills/async-python-patterns/SKILL.md +0 -694
  171. package/templates/skills/auth-implementation-patterns/SKILL.md +0 -634
  172. package/templates/skills/changelog-automation/SKILL.md +0 -552
  173. package/templates/skills/code-review/SKILL.md +0 -62
  174. package/templates/skills/code-review-excellence/SKILL.md +0 -520
  175. package/templates/skills/competitive-landscape/SKILL.md +0 -479
  176. package/templates/skills/context-driven-development/SKILL.md +0 -385
  177. package/templates/skills/cost-optimization/SKILL.md +0 -274
  178. package/templates/skills/cqrs-implementation/SKILL.md +0 -554
  179. package/templates/skills/data-quality-frameworks/SKILL.md +0 -587
  180. package/templates/skills/data-storytelling/SKILL.md +0 -453
  181. package/templates/skills/database-migration/SKILL.md +0 -424
  182. package/templates/skills/dbt-transformation-patterns/SKILL.md +0 -561
  183. package/templates/skills/debugging-strategies/SKILL.md +0 -527
  184. package/templates/skills/defi-protocol-templates/SKILL.md +0 -454
  185. package/templates/skills/dependency-upgrade/SKILL.md +0 -409
  186. package/templates/skills/deployment-pipeline-design/SKILL.md +0 -359
  187. package/templates/skills/distributed-tracing/SKILL.md +0 -438
  188. package/templates/skills/dotnet-backend-patterns/SKILL.md +0 -815
  189. package/templates/skills/dotnet-backend-patterns/assets/repository-template.cs +0 -523
  190. package/templates/skills/dotnet-backend-patterns/assets/service-template.cs +0 -336
  191. package/templates/skills/dotnet-backend-patterns/references/dapper-patterns.md +0 -544
  192. package/templates/skills/dotnet-backend-patterns/references/ef-core-best-practices.md +0 -355
  193. package/templates/skills/e2e-testing-patterns/SKILL.md +0 -547
  194. package/templates/skills/employment-contract-templates/SKILL.md +0 -507
  195. package/templates/skills/error-handling-patterns/SKILL.md +0 -636
  196. package/templates/skills/event-store-design/SKILL.md +0 -437
  197. package/templates/skills/fastapi-templates/SKILL.md +0 -567
  198. package/templates/skills/git-advanced-workflows/SKILL.md +0 -400
  199. package/templates/skills/github-actions-templates/SKILL.md +0 -333
  200. package/templates/skills/go-concurrency-patterns/SKILL.md +0 -655
  201. package/templates/skills/grafana-dashboards/SKILL.md +0 -369
  202. package/templates/skills/helm-chart-scaffolding/SKILL.md +0 -544
  203. package/templates/skills/helm-chart-scaffolding/assets/Chart.yaml.template +0 -42
  204. package/templates/skills/helm-chart-scaffolding/assets/values.yaml.template +0 -185
  205. package/templates/skills/helm-chart-scaffolding/references/chart-structure.md +0 -500
  206. package/templates/skills/helm-chart-scaffolding/scripts/validate-chart.sh +0 -244
  207. package/templates/skills/javascript-testing-patterns/SKILL.md +0 -1025
  208. package/templates/skills/langchain-architecture/SKILL.md +0 -338
  209. package/templates/skills/llm-evaluation/SKILL.md +0 -471
  210. package/templates/skills/microservices-patterns/SKILL.md +0 -595
  211. package/templates/skills/modern-javascript-patterns/SKILL.md +0 -911
  212. package/templates/skills/monorepo-management/SKILL.md +0 -622
  213. package/templates/skills/nextjs-app-router-patterns/SKILL.md +0 -544
  214. package/templates/skills/nodejs-backend-patterns/SKILL.md +0 -1020
  215. package/templates/skills/nx-workspace-patterns/SKILL.md +0 -452
  216. package/templates/skills/openapi-spec-generation/SKILL.md +0 -1028
  217. package/templates/skills/paypal-integration/SKILL.md +0 -467
  218. package/templates/skills/pci-compliance/SKILL.md +0 -466
  219. package/templates/skills/postgresql/SKILL.md +0 -204
  220. package/templates/skills/projection-patterns/SKILL.md +0 -490
  221. package/templates/skills/prometheus-configuration/SKILL.md +0 -392
  222. package/templates/skills/prompt-engineering-patterns/SKILL.md +0 -201
  223. package/templates/skills/prompt-engineering-patterns/assets/few-shot-examples.json +0 -106
  224. package/templates/skills/prompt-engineering-patterns/assets/prompt-template-library.md +0 -246
  225. package/templates/skills/prompt-engineering-patterns/references/chain-of-thought.md +0 -399
  226. package/templates/skills/prompt-engineering-patterns/references/few-shot-learning.md +0 -369
  227. package/templates/skills/prompt-engineering-patterns/references/prompt-optimization.md +0 -414
  228. package/templates/skills/prompt-engineering-patterns/references/prompt-templates.md +0 -470
  229. package/templates/skills/prompt-engineering-patterns/references/system-prompts.md +0 -189
  230. package/templates/skills/prompt-engineering-patterns/scripts/optimize-prompt.py +0 -279
  231. package/templates/skills/python-packaging/SKILL.md +0 -870
  232. package/templates/skills/python-performance-optimization/SKILL.md +0 -869
  233. package/templates/skills/python-testing-patterns/SKILL.md +0 -907
  234. package/templates/skills/rag-implementation/SKILL.md +0 -403
  235. package/templates/skills/react-modernization/SKILL.md +0 -513
  236. package/templates/skills/react-native-architecture/SKILL.md +0 -671
  237. package/templates/skills/react-state-management/SKILL.md +0 -429
  238. package/templates/skills/risk-metrics-calculation/SKILL.md +0 -555
  239. package/templates/skills/rust-async-patterns/SKILL.md +0 -517
  240. package/templates/skills/secrets-management/SKILL.md +0 -346
  241. package/templates/skills/security-requirement-extraction/SKILL.md +0 -677
  242. package/templates/skills/security-review/SKILL.md +0 -78
  243. package/templates/skills/shellcheck-configuration/SKILL.md +0 -454
  244. package/templates/skills/similarity-search-patterns/SKILL.md +0 -558
  245. package/templates/skills/slo-implementation/SKILL.md +0 -329
  246. package/templates/skills/sql-optimization-patterns/SKILL.md +0 -493
  247. package/templates/skills/stripe-integration/SKILL.md +0 -442
  248. package/templates/skills/systematic-debugging/SKILL.md +0 -57
  249. package/templates/skills/tailwind-design-system/SKILL.md +0 -666
  250. package/templates/skills/temporal-python-testing/SKILL.md +0 -158
  251. package/templates/skills/temporal-python-testing/resources/integration-testing.md +0 -455
  252. package/templates/skills/temporal-python-testing/resources/local-setup.md +0 -553
  253. package/templates/skills/temporal-python-testing/resources/replay-testing.md +0 -462
  254. package/templates/skills/temporal-python-testing/resources/unit-testing.md +0 -328
  255. package/templates/skills/terraform-module-library/SKILL.md +0 -249
  256. package/templates/skills/terraform-module-library/references/aws-modules.md +0 -63
  257. package/templates/skills/test-driven-development/SKILL.md +0 -46
  258. package/templates/skills/threat-mitigation-mapping/SKILL.md +0 -745
  259. package/templates/skills/track-management/SKILL.md +0 -593
  260. package/templates/skills/typescript-advanced-types/SKILL.md +0 -717
  261. package/templates/skills/ui-ux-pro-max/SKILL.md +0 -352
  262. package/templates/skills/ui-ux-pro-max/data/charts.csv +0 -26
  263. package/templates/skills/ui-ux-pro-max/data/colors.csv +0 -97
  264. package/templates/skills/ui-ux-pro-max/data/icons.csv +0 -101
  265. package/templates/skills/ui-ux-pro-max/data/landing.csv +0 -31
  266. package/templates/skills/ui-ux-pro-max/data/products.csv +0 -97
  267. package/templates/skills/ui-ux-pro-max/data/prompts.csv +0 -24
  268. package/templates/skills/ui-ux-pro-max/data/react-performance.csv +0 -45
  269. package/templates/skills/ui-ux-pro-max/data/styles.csv +0 -59
  270. package/templates/skills/ui-ux-pro-max/data/typography.csv +0 -58
  271. package/templates/skills/ui-ux-pro-max/data/ui-reasoning.csv +0 -101
  272. package/templates/skills/ui-ux-pro-max/data/ux-guidelines.csv +0 -100
  273. package/templates/skills/ui-ux-pro-max/data/web-interface.csv +0 -31
  274. package/templates/skills/ui-ux-pro-max/scripts/core.py +0 -258
  275. package/templates/skills/ui-ux-pro-max/scripts/design_system.py +0 -547
  276. package/templates/skills/ui-ux-pro-max/scripts/search.py +0 -76
  277. package/templates/skills/uv-package-manager/SKILL.md +0 -831
  278. package/templates/skills/vector-index-tuning/SKILL.md +0 -521
  279. package/templates/skills/wcag-audit-patterns/SKILL.md +0 -555
  280. package/templates/skills/workflow-orchestration-patterns/SKILL.md +0 -316
  281. package/templates/skills/workflow-patterns/SKILL.md +0 -623
  282. package/templates/skills/writing-plans/SKILL.md +0 -64
@@ -1,552 +0,0 @@
1
- ---
2
- name: changelog-automation
3
- description: Automate changelog generation from commits, PRs, and releases following Keep a Changelog format. Use when setting up release workflows, generating release notes, or standardizing commit conventions.
4
- ---
5
-
6
- # Changelog Automation
7
-
8
- Patterns and tools for automating changelog generation, release notes, and version management following industry standards.
9
-
10
- ## When to Use This Skill
11
-
12
- - Setting up automated changelog generation
13
- - Implementing Conventional Commits
14
- - Creating release note workflows
15
- - Standardizing commit message formats
16
- - Generating GitHub/GitLab release notes
17
- - Managing semantic versioning
18
-
19
- ## Core Concepts
20
-
21
- ### 1. Keep a Changelog Format
22
-
23
- ```markdown
24
- # Changelog
25
-
26
- All notable changes to this project will be documented in this file.
27
-
28
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
29
- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
30
-
31
- ## [Unreleased]
32
-
33
- ### Added
34
- - New feature X
35
-
36
- ## [1.2.0] - 2024-01-15
37
-
38
- ### Added
39
- - User profile avatars
40
- - Dark mode support
41
-
42
- ### Changed
43
- - Improved loading performance by 40%
44
-
45
- ### Deprecated
46
- - Old authentication API (use v2)
47
-
48
- ### Removed
49
- - Legacy payment gateway
50
-
51
- ### Fixed
52
- - Login timeout issue (#123)
53
-
54
- ### Security
55
- - Updated dependencies for CVE-2024-1234
56
-
57
- [Unreleased]: https://github.com/user/repo/compare/v1.2.0...HEAD
58
- [1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0
59
- ```
60
-
61
- ### 2. Conventional Commits
62
-
63
- ```
64
- <type>[optional scope]: <description>
65
-
66
- [optional body]
67
-
68
- [optional footer(s)]
69
- ```
70
-
71
- | Type | Description | Changelog Section |
72
- |------|-------------|-------------------|
73
- | `feat` | New feature | Added |
74
- | `fix` | Bug fix | Fixed |
75
- | `docs` | Documentation | (usually excluded) |
76
- | `style` | Formatting | (usually excluded) |
77
- | `refactor` | Code restructure | Changed |
78
- | `perf` | Performance | Changed |
79
- | `test` | Tests | (usually excluded) |
80
- | `chore` | Maintenance | (usually excluded) |
81
- | `ci` | CI changes | (usually excluded) |
82
- | `build` | Build system | (usually excluded) |
83
- | `revert` | Revert commit | Removed |
84
-
85
- ### 3. Semantic Versioning
86
-
87
- ```
88
- MAJOR.MINOR.PATCH
89
-
90
- MAJOR: Breaking changes (feat! or BREAKING CHANGE)
91
- MINOR: New features (feat)
92
- PATCH: Bug fixes (fix)
93
- ```
94
-
95
- ## Implementation
96
-
97
- ### Method 1: Conventional Changelog (Node.js)
98
-
99
- ```bash
100
- # Install tools
101
- npm install -D @commitlint/cli @commitlint/config-conventional
102
- npm install -D husky
103
- npm install -D standard-version
104
- # or
105
- npm install -D semantic-release
106
-
107
- # Setup commitlint
108
- cat > commitlint.config.js << 'EOF'
109
- module.exports = {
110
- extends: ['@commitlint/config-conventional'],
111
- rules: {
112
- 'type-enum': [
113
- 2,
114
- 'always',
115
- [
116
- 'feat',
117
- 'fix',
118
- 'docs',
119
- 'style',
120
- 'refactor',
121
- 'perf',
122
- 'test',
123
- 'chore',
124
- 'ci',
125
- 'build',
126
- 'revert',
127
- ],
128
- ],
129
- 'subject-case': [2, 'never', ['start-case', 'pascal-case', 'upper-case']],
130
- 'subject-max-length': [2, 'always', 72],
131
- },
132
- };
133
- EOF
134
-
135
- # Setup husky
136
- npx husky init
137
- echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
138
- ```
139
-
140
- ### Method 2: standard-version Configuration
141
-
142
- ```javascript
143
- // .versionrc.js
144
- module.exports = {
145
- types: [
146
- { type: 'feat', section: 'Features' },
147
- { type: 'fix', section: 'Bug Fixes' },
148
- { type: 'perf', section: 'Performance Improvements' },
149
- { type: 'revert', section: 'Reverts' },
150
- { type: 'docs', section: 'Documentation', hidden: true },
151
- { type: 'style', section: 'Styles', hidden: true },
152
- { type: 'chore', section: 'Miscellaneous', hidden: true },
153
- { type: 'refactor', section: 'Code Refactoring', hidden: true },
154
- { type: 'test', section: 'Tests', hidden: true },
155
- { type: 'build', section: 'Build System', hidden: true },
156
- { type: 'ci', section: 'CI/CD', hidden: true },
157
- ],
158
- commitUrlFormat: '{{host}}/{{owner}}/{{repository}}/commit/{{hash}}',
159
- compareUrlFormat: '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}',
160
- issueUrlFormat: '{{host}}/{{owner}}/{{repository}}/issues/{{id}}',
161
- userUrlFormat: '{{host}}/{{user}}',
162
- releaseCommitMessageFormat: 'chore(release): {{currentTag}}',
163
- scripts: {
164
- prebump: 'echo "Running prebump"',
165
- postbump: 'echo "Running postbump"',
166
- prechangelog: 'echo "Running prechangelog"',
167
- postchangelog: 'echo "Running postchangelog"',
168
- },
169
- };
170
- ```
171
-
172
- ```json
173
- // package.json scripts
174
- {
175
- "scripts": {
176
- "release": "standard-version",
177
- "release:minor": "standard-version --release-as minor",
178
- "release:major": "standard-version --release-as major",
179
- "release:patch": "standard-version --release-as patch",
180
- "release:dry": "standard-version --dry-run"
181
- }
182
- }
183
- ```
184
-
185
- ### Method 3: semantic-release (Full Automation)
186
-
187
- ```javascript
188
- // release.config.js
189
- module.exports = {
190
- branches: [
191
- 'main',
192
- { name: 'beta', prerelease: true },
193
- { name: 'alpha', prerelease: true },
194
- ],
195
- plugins: [
196
- '@semantic-release/commit-analyzer',
197
- '@semantic-release/release-notes-generator',
198
- [
199
- '@semantic-release/changelog',
200
- {
201
- changelogFile: 'CHANGELOG.md',
202
- },
203
- ],
204
- [
205
- '@semantic-release/npm',
206
- {
207
- npmPublish: true,
208
- },
209
- ],
210
- [
211
- '@semantic-release/github',
212
- {
213
- assets: ['dist/**/*.js', 'dist/**/*.css'],
214
- },
215
- ],
216
- [
217
- '@semantic-release/git',
218
- {
219
- assets: ['CHANGELOG.md', 'package.json'],
220
- message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
221
- },
222
- ],
223
- ],
224
- };
225
- ```
226
-
227
- ### Method 4: GitHub Actions Workflow
228
-
229
- ```yaml
230
- # .github/workflows/release.yml
231
- name: Release
232
-
233
- on:
234
- push:
235
- branches: [main]
236
- workflow_dispatch:
237
- inputs:
238
- release_type:
239
- description: 'Release type'
240
- required: true
241
- default: 'patch'
242
- type: choice
243
- options:
244
- - patch
245
- - minor
246
- - major
247
-
248
- permissions:
249
- contents: write
250
- pull-requests: write
251
-
252
- jobs:
253
- release:
254
- runs-on: ubuntu-latest
255
- steps:
256
- - uses: actions/checkout@v4
257
- with:
258
- fetch-depth: 0
259
- token: ${{ secrets.GITHUB_TOKEN }}
260
-
261
- - uses: actions/setup-node@v4
262
- with:
263
- node-version: '20'
264
- cache: 'npm'
265
-
266
- - run: npm ci
267
-
268
- - name: Configure Git
269
- run: |
270
- git config user.name "github-actions[bot]"
271
- git config user.email "github-actions[bot]@users.noreply.github.com"
272
-
273
- - name: Run semantic-release
274
- env:
275
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
276
- NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
277
- run: npx semantic-release
278
-
279
- # Alternative: manual release with standard-version
280
- manual-release:
281
- if: github.event_name == 'workflow_dispatch'
282
- runs-on: ubuntu-latest
283
- steps:
284
- - uses: actions/checkout@v4
285
- with:
286
- fetch-depth: 0
287
-
288
- - uses: actions/setup-node@v4
289
- with:
290
- node-version: '20'
291
-
292
- - run: npm ci
293
-
294
- - name: Configure Git
295
- run: |
296
- git config user.name "github-actions[bot]"
297
- git config user.email "github-actions[bot]@users.noreply.github.com"
298
-
299
- - name: Bump version and generate changelog
300
- run: npx standard-version --release-as ${{ inputs.release_type }}
301
-
302
- - name: Push changes
303
- run: git push --follow-tags origin main
304
-
305
- - name: Create GitHub Release
306
- uses: softprops/action-gh-release@v1
307
- with:
308
- tag_name: ${{ steps.version.outputs.tag }}
309
- body_path: RELEASE_NOTES.md
310
- generate_release_notes: true
311
- ```
312
-
313
- ### Method 5: git-cliff (Rust-based, Fast)
314
-
315
- ```toml
316
- # cliff.toml
317
- [changelog]
318
- header = """
319
- # Changelog
320
-
321
- All notable changes to this project will be documented in this file.
322
-
323
- """
324
- body = """
325
- {% if version %}\
326
- ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
327
- {% else %}\
328
- ## [Unreleased]
329
- {% endif %}\
330
- {% for group, commits in commits | group_by(attribute="group") %}
331
- ### {{ group | upper_first }}
332
- {% for commit in commits %}
333
- - {% if commit.scope %}**{{ commit.scope }}:** {% endif %}\
334
- {{ commit.message | upper_first }}\
335
- {% if commit.github.pr_number %} ([#{{ commit.github.pr_number }}](https://github.com/owner/repo/pull/{{ commit.github.pr_number }})){% endif %}\
336
- {% endfor %}
337
- {% endfor %}
338
- """
339
- footer = """
340
- {% for release in releases -%}
341
- {% if release.version -%}
342
- {% if release.previous.version -%}
343
- [{{ release.version | trim_start_matches(pat="v") }}]: \
344
- https://github.com/owner/repo/compare/{{ release.previous.version }}...{{ release.version }}
345
- {% endif -%}
346
- {% else -%}
347
- [unreleased]: https://github.com/owner/repo/compare/{{ release.previous.version }}...HEAD
348
- {% endif -%}
349
- {% endfor %}
350
- """
351
- trim = true
352
-
353
- [git]
354
- conventional_commits = true
355
- filter_unconventional = true
356
- split_commits = false
357
- commit_parsers = [
358
- { message = "^feat", group = "Features" },
359
- { message = "^fix", group = "Bug Fixes" },
360
- { message = "^doc", group = "Documentation" },
361
- { message = "^perf", group = "Performance" },
362
- { message = "^refactor", group = "Refactoring" },
363
- { message = "^style", group = "Styling" },
364
- { message = "^test", group = "Testing" },
365
- { message = "^chore\\(release\\)", skip = true },
366
- { message = "^chore", group = "Miscellaneous" },
367
- ]
368
- filter_commits = false
369
- tag_pattern = "v[0-9]*"
370
- skip_tags = ""
371
- ignore_tags = ""
372
- topo_order = false
373
- sort_commits = "oldest"
374
-
375
- [github]
376
- owner = "owner"
377
- repo = "repo"
378
- ```
379
-
380
- ```bash
381
- # Generate changelog
382
- git cliff -o CHANGELOG.md
383
-
384
- # Generate for specific range
385
- git cliff v1.0.0..v2.0.0 -o RELEASE_NOTES.md
386
-
387
- # Preview without writing
388
- git cliff --unreleased --dry-run
389
- ```
390
-
391
- ### Method 6: Python (commitizen)
392
-
393
- ```toml
394
- # pyproject.toml
395
- [tool.commitizen]
396
- name = "cz_conventional_commits"
397
- version = "1.0.0"
398
- version_files = [
399
- "pyproject.toml:version",
400
- "src/__init__.py:__version__",
401
- ]
402
- tag_format = "v$version"
403
- update_changelog_on_bump = true
404
- changelog_incremental = true
405
- changelog_start_rev = "v0.1.0"
406
-
407
- [tool.commitizen.customize]
408
- message_template = "{{change_type}}{% if scope %}({{scope}}){% endif %}: {{message}}"
409
- schema = "<type>(<scope>): <subject>"
410
- schema_pattern = "^(feat|fix|docs|style|refactor|perf|test|chore)(\\(\\w+\\))?:\\s.*"
411
- bump_pattern = "^(feat|fix|perf|refactor)"
412
- bump_map = {"feat" = "MINOR", "fix" = "PATCH", "perf" = "PATCH", "refactor" = "PATCH"}
413
- ```
414
-
415
- ```bash
416
- # Install
417
- pip install commitizen
418
-
419
- # Create commit interactively
420
- cz commit
421
-
422
- # Bump version and update changelog
423
- cz bump --changelog
424
-
425
- # Check commits
426
- cz check --rev-range HEAD~5..HEAD
427
- ```
428
-
429
- ## Release Notes Templates
430
-
431
- ### GitHub Release Template
432
-
433
- ```markdown
434
- ## What's Changed
435
-
436
- ### 🚀 Features
437
- {{ range .Features }}
438
- - {{ .Title }} by @{{ .Author }} in #{{ .PR }}
439
- {{ end }}
440
-
441
- ### 🐛 Bug Fixes
442
- {{ range .Fixes }}
443
- - {{ .Title }} by @{{ .Author }} in #{{ .PR }}
444
- {{ end }}
445
-
446
- ### 📚 Documentation
447
- {{ range .Docs }}
448
- - {{ .Title }} by @{{ .Author }} in #{{ .PR }}
449
- {{ end }}
450
-
451
- ### 🔧 Maintenance
452
- {{ range .Chores }}
453
- - {{ .Title }} by @{{ .Author }} in #{{ .PR }}
454
- {{ end }}
455
-
456
- ## New Contributors
457
- {{ range .NewContributors }}
458
- - @{{ .Username }} made their first contribution in #{{ .PR }}
459
- {{ end }}
460
-
461
- **Full Changelog**: https://github.com/owner/repo/compare/v{{ .Previous }}...v{{ .Current }}
462
- ```
463
-
464
- ### Internal Release Notes
465
-
466
- ```markdown
467
- # Release v2.1.0 - January 15, 2024
468
-
469
- ## Summary
470
- This release introduces dark mode support and improves checkout performance
471
- by 40%. It also includes important security updates.
472
-
473
- ## Highlights
474
-
475
- ### 🌙 Dark Mode
476
- Users can now switch to dark mode from settings. The preference is
477
- automatically saved and synced across devices.
478
-
479
- ### ⚡ Performance
480
- - Checkout flow is 40% faster
481
- - Reduced bundle size by 15%
482
-
483
- ## Breaking Changes
484
- None in this release.
485
-
486
- ## Upgrade Guide
487
- No special steps required. Standard deployment process applies.
488
-
489
- ## Known Issues
490
- - Dark mode may flicker on initial load (fix scheduled for v2.1.1)
491
-
492
- ## Dependencies Updated
493
- | Package | From | To | Reason |
494
- |---------|------|-----|--------|
495
- | react | 18.2.0 | 18.3.0 | Performance improvements |
496
- | lodash | 4.17.20 | 4.17.21 | Security patch |
497
- ```
498
-
499
- ## Commit Message Examples
500
-
501
- ```bash
502
- # Feature with scope
503
- feat(auth): add OAuth2 support for Google login
504
-
505
- # Bug fix with issue reference
506
- fix(checkout): resolve race condition in payment processing
507
-
508
- Closes #123
509
-
510
- # Breaking change
511
- feat(api)!: change user endpoint response format
512
-
513
- BREAKING CHANGE: The user endpoint now returns `userId` instead of `id`.
514
- Migration guide: Update all API consumers to use the new field name.
515
-
516
- # Multiple paragraphs
517
- fix(database): handle connection timeouts gracefully
518
-
519
- Previously, connection timeouts would cause the entire request to fail
520
- without retry. This change implements exponential backoff with up to
521
- 3 retries before failing.
522
-
523
- The timeout threshold has been increased from 5s to 10s based on p99
524
- latency analysis.
525
-
526
- Fixes #456
527
- Reviewed-by: @alice
528
- ```
529
-
530
- ## Best Practices
531
-
532
- ### Do's
533
- - **Follow Conventional Commits** - Enables automation
534
- - **Write clear messages** - Future you will thank you
535
- - **Reference issues** - Link commits to tickets
536
- - **Use scopes consistently** - Define team conventions
537
- - **Automate releases** - Reduce manual errors
538
-
539
- ### Don'ts
540
- - **Don't mix changes** - One logical change per commit
541
- - **Don't skip validation** - Use commitlint
542
- - **Don't manual edit** - Generated changelogs only
543
- - **Don't forget breaking changes** - Mark with `!` or footer
544
- - **Don't ignore CI** - Validate commits in pipeline
545
-
546
- ## Resources
547
-
548
- - [Keep a Changelog](https://keepachangelog.com/)
549
- - [Conventional Commits](https://www.conventionalcommits.org/)
550
- - [Semantic Versioning](https://semver.org/)
551
- - [semantic-release](https://semantic-release.gitbook.io/)
552
- - [git-cliff](https://git-cliff.org/)
@@ -1,62 +0,0 @@
1
- ---
2
- name: code-review
3
- description: Automated code review checklist. Use when reviewing PRs or code changes.
4
- license: MIT
5
- ---
6
-
7
- # Code Review
8
-
9
- Comprehensive checklist for reviewing code changes.
10
-
11
- ## Pre-Review Checklist
12
-
13
- Before starting the review:
14
-
15
- - [ ] Understand the context and requirements
16
- - [ ] Check if tests are included
17
- - [ ] Verify CI/CD passes
18
-
19
- ## Review Categories
20
-
21
- ### 1. Correctness
22
-
23
- - Does the code do what it's supposed to?
24
- - Are edge cases handled?
25
- - Are there potential bugs or race conditions?
26
-
27
- ### 2. Design
28
-
29
- - Is the code well-structured?
30
- - Does it follow SOLID principles?
31
- - Is there unnecessary complexity?
32
-
33
- ### 3. Readability
34
-
35
- - Are variable/function names clear?
36
- - Is the code self-documenting?
37
- - Are comments helpful (not redundant)?
38
-
39
- ### 4. Performance
40
-
41
- - Are there obvious performance issues?
42
- - Is there unnecessary work being done?
43
- - Are there N+1 queries or similar patterns?
44
-
45
- ### 5. Security
46
-
47
- - Is user input validated?
48
- - Are there potential injection vulnerabilities?
49
- - Is sensitive data handled properly?
50
-
51
- ### 6. Testing
52
-
53
- - Are tests comprehensive?
54
- - Do tests cover edge cases?
55
- - Are tests maintainable?
56
-
57
- ## Providing Feedback
58
-
59
- - Be specific and constructive
60
- - Explain the "why" behind suggestions
61
- - Differentiate between blocking and non-blocking issues
62
- - Acknowledge good code