Skip to content

Commit 85378c5

Browse files
jdxclaudeautofix-ci[bot]
authored
docs: add conventional commit guidance to CLAUDE.md (#459)
## Summary - Add conventional commit format guidance - Include project-specific scopes (shells, spec, parse, complete) - Add description style guidelines and examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds clear conventional commit standards to `CLAUDE.md` to standardize commit messages and PR titles. > > - Introduces commit format (`<type>(<scope>): <description>`), supported types, and project-specific scopes > - Defines description style rules (lowercase after colon, imperative mood, concise) > - Provides concrete examples for common changes > > No code or build logic changes; documentation update only. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit c808060. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Claude Opus 4.5 <[email protected]> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 7ff8eb6 commit 85378c5

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CLAUDE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,43 @@
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5+
## Conventional Commits
6+
7+
All commit messages and PR titles MUST follow conventional commit format:
8+
9+
**Format:** `<type>(<scope>): <description>`
10+
11+
**Types:**
12+
13+
- `feat:` - New features
14+
- `fix:` - Bug fixes
15+
- `refactor:` - Code refactoring
16+
- `docs:` - Documentation changes
17+
- `style:` - Code style/formatting (no logic changes)
18+
- `perf:` - Performance improvements
19+
- `test:` - Testing changes
20+
- `chore:` - Maintenance tasks, releases, dependency updates
21+
- `security:` - Security-related changes
22+
23+
**Scopes:**
24+
25+
- For shell-specific changes: `bash`, `zsh`, `fish`, `powershell`
26+
- For subsystem changes: `spec`, `parse`, `complete`, `docs`, `manpage`, `lib`, `cli`, `deps`
27+
28+
**Description Style:**
29+
30+
- Use lowercase after the colon
31+
- Use imperative mood ("add feature" not "added feature")
32+
- Keep it concise but descriptive
33+
34+
**Examples:**
35+
36+
- `fix(zsh): handle spaces in completion values`
37+
- `feat(powershell): add completion support`
38+
- `feat(spec): add mount node for nested specs`
39+
- `docs: update KDL spec format examples`
40+
- `chore: release 2.0.0`
41+
542
## Project Overview
643

744
Usage is a spec and CLI for defining CLI tools using KDL format. It generates shell completions, markdown docs, and man pages from a single spec file. Think OpenAPI/Swagger for CLIs.

0 commit comments

Comments
 (0)