You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add conventional commit guidelines to CLAUDE.md
Added comprehensive commit message guidelines including:
- Conventional Commit format specification
- Common commit types (feat, fix, docs, test, refactor, perf, chore)
- Examples of well-formatted commits
- Multi-line commit format for complex changes
- CI skip notation with requirement to place on separate line
[ci skip]
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CLAUDE.md
+49Lines changed: 49 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -130,6 +130,55 @@ The build script runs the complete validation pipeline including tests, samples,
130
130
131
131
This approach ensures code correctness, prevents regressions, and validates that tests actually catch the issues they're meant to detect. The test suite already has good coverage and patterns to follow.
132
132
133
+
## Commit Guidelines
134
+
135
+
**IMPORTANT:** Use Conventional Commit format for all commit messages. This ensures consistency and enables automated changelog generation.
-`refactor:` Code changes that neither fix bugs nor add features
145
+
-`perf:` Performance improvements
146
+
-`chore:` Build scripts, dependencies, tooling
147
+
148
+
**Examples:**
149
+
```
150
+
feat: add support for nested subcommands
151
+
fix: resolve null reference in argument parser
152
+
docs: update getting started guide
153
+
test: add coverage for validation attributes
154
+
refactor: simplify help text generation logic
155
+
```
156
+
157
+
**Multi-line commits:** For complex changes, use a blank line followed by a detailed body:
158
+
```
159
+
fix: resolve race condition in async command execution
160
+
161
+
The ExecuteAsync method was not properly awaiting disposal of
162
+
resources, leading to intermittent failures in concurrent scenarios.
163
+
Added proper async/await pattern and additional test coverage.
164
+
```
165
+
166
+
**Skipping CI:** For commits that don't require CI validation (documentation, README updates, comment changes), add `[ci skip]` on its own line in the commit body. **IMPORTANT:** Never include `[ci skip]` in the first line of the commit message.
167
+
168
+
```
169
+
docs: update installation instructions
170
+
171
+
[ci skip]
172
+
```
173
+
174
+
```
175
+
docs: fix typo in API documentation
176
+
177
+
[ci skip]
178
+
```
179
+
180
+
This prevents unnecessary CI builds and saves resources for changes that don't affect code functionality.
0 commit comments