Skip to content

Commit 420197e

Browse files
louis-preclaude
andcommitted
docs: Clarify semantic commit type guidelines in CLAUDE.md
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent a24ff5d commit 420197e

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,15 @@ npm run validate-redirects # Validate .gitbook.yaml redirects
2222

2323
**Always run `npm run format` before committing.** CI auto-commits formatting fixes on non-main branches, but formatting locally avoids noise.
2424

25-
**Use semantic naming for commits, branches, and PRs.** Prefix commit messages with a type (`feat:`, `fix:`, `docs:`, `chore:`, `ci:`, `refactor:`, `test:`). Use the same style for branch names (e.g., `docs/update-sandbox-credentials`) and PR titles.
25+
**Use semantic naming for commits, branches, and PRs.** Prefix commit messages with a type and use the same style for branch names (e.g., `feat/add-smart-locks-guide`) and PR titles. Types:
26+
27+
- `docs:` — changes to project documentation (CLAUDE.md, README, inline comments)
28+
- `feat:` — user-visible changes that are not fixes (new pages, reorganization, content updates)
29+
- `fix:` — bug fixes, whether user-visible or internal
30+
- `refactor:` — internal changes invisible to users (codegen pipeline, tooling, code structure)
31+
- `chore:` — maintenance tasks (dependency updates, cleanup)
32+
- `ci:` — CI/CD pipeline changes
33+
- `test:` — adding or updating tests
2634

2735
Optional external tools used during `npm run generate` for code sample formatting: `ruff` (Python), `shfmt` (shell), `gofmt` (Go), `stree` from `syntax_tree` gem (Ruby).
2836

0 commit comments

Comments
 (0)