Skip to content

Commit a700a8d

Browse files
committed
style: format doc
1 parent ee54cc5 commit a700a8d

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

.claude/commands/commit.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,22 @@ Generates commit messages following [Conventional Commits v1.0.0](https://www.co
3838

3939
Analyze staged changes and suggest the most appropriate type:
4040

41-
| Type | When to Use | SemVer Impact |
42-
|------|-------------|---------------|
43-
| **feat** | New feature or capability added | MINOR (0.x.0) |
44-
| **fix** | Bug fix or problem resolution | PATCH (0.0.x) |
45-
| **docs** | Documentation only changes (README, comments, etc.) | None |
46-
| **style** | Code formatting, missing semicolons (no logic change) | None |
47-
| **refactor** | Code restructuring without changing behavior | None |
48-
| **perf** | Performance improvements | PATCH |
49-
| **test** | Adding or fixing tests | None |
50-
| **chore** | Build config, dependencies, tooling updates | None |
51-
| **ci** | CI/CD configuration changes | None |
41+
| Type | When to Use | SemVer Impact |
42+
| ------------ | ----------------------------------------------------- | ------------- |
43+
| **feat** | New feature or capability added | MINOR (0.x.0) |
44+
| **fix** | Bug fix or problem resolution | PATCH (0.0.x) |
45+
| **docs** | Documentation only changes (README, comments, etc.) | None |
46+
| **style** | Code formatting, missing semicolons (no logic change) | None |
47+
| **refactor** | Code restructuring without changing behavior | None |
48+
| **perf** | Performance improvements | PATCH |
49+
| **test** | Adding or fixing tests | None |
50+
| **chore** | Build config, dependencies, tooling updates | None |
51+
| **ci** | CI/CD configuration changes | None |
5252

5353
**BREAKING CHANGE**: MUST use both type! format (exclamation mark after type) AND BREAKING CHANGE: footer with migration guide for major version bump.
5454

5555
Example:
56+
5657
```
5758
feat!: change API response format from JSON to MessagePack
5859
@@ -85,16 +86,17 @@ If multiple types apply, prioritize: `feat` > `fix` > other types.
8586

8687
**Key distinction**: Does it affect **users** or only **developers**?
8788

88-
| Scenario | Type | Reason |
89-
|----------|------|--------|
90-
| Backend GitHub Actions test workflow not running | `chore` | Only affects CI/CD, users don't experience this |
91-
| API returns 500 error for valid requests | `fix` | Users experience error responses |
92-
| Page loading speed improved from 3s to 0.8s | `perf` | Users directly feel the improvement |
93-
| Internal database query optimization (no user impact) | `refactor` | Code improvement, no measurable user benefit |
94-
| Dependency security patch (CVE fix) | `chore` | Build/tooling update |
95-
| App crashes when accessing profile page | `fix` | Users experience crash |
89+
| Scenario | Type | Reason |
90+
| ----------------------------------------------------- | ---------- | ----------------------------------------------- |
91+
| Backend GitHub Actions test workflow not running | `chore` | Only affects CI/CD, users don't experience this |
92+
| API returns 500 error for valid requests | `fix` | Users experience error responses |
93+
| Page loading speed improved from 3s to 0.8s | `perf` | Users directly feel the improvement |
94+
| Internal database query optimization (no user impact) | `refactor` | Code improvement, no measurable user benefit |
95+
| Dependency security patch (CVE fix) | `chore` | Build/tooling update |
96+
| App crashes when accessing profile page | `fix` | Users experience crash |
9697

9798
**User perspective priority:**
99+
98100
- ✅ "fix: app crashes when deleting items" (user problem)
99101
- ❌ "fix: null pointer exception in ItemService" (code problem)
100102

@@ -118,6 +120,7 @@ type: brief description
118120
```
119121

120122
**Example:**
123+
121124
```
122125
docs: fix typo in README
123126
```
@@ -131,6 +134,7 @@ What problem occurred and how it was resolved in one or two lines
131134
```
132135

133136
**Example:**
137+
134138
```
135139
fix: login button not responding with empty fields
136140
@@ -161,6 +165,7 @@ fix #N
161165
```
162166

163167
**Example:**
168+
164169
```
165170
fix: user list page failing to load
166171
@@ -190,6 +195,7 @@ fix #N
190195
```
191196

192197
**Example:**
198+
193199
```
194200
fix: users being logged out after service updates
195201
@@ -248,6 +254,7 @@ The command will provide:
248254
7. Present suggested type with reasoning
249255

250256
**Token optimization**: Focus git diff analysis on:
257+
251258
- New/deleted files → likely `feat` or `refactor`
252259
- Modified files in src/ → check if bug fix or feature
253260
- Modified docs/README → `docs`

0 commit comments

Comments
 (0)