Skip to content

Commit df1b3c7

Browse files
committed
docs(claude): add commit conventions section
Documents the project's use of Conventional Commits, the expected title/brief shape, and the no-Co-Authored-By rule.
1 parent 5c0cdc8 commit df1b3c7

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,11 @@ Key subdirectories: `PixelStreaming/` (main client class), `PeerConnectionContro
107107
## Releases and versioning
108108

109109
Uses **Changesets** (`@changesets/cli`) for versioning and changelogs. The `.backportrc.json` enables automatic backporting to prior UE version branches. NPM publishing and Docker image builds are automated via GitHub Actions on release branches.
110+
111+
## Commit conventions
112+
113+
Use **Conventional Commits**. The subject line should be a short, imperative title prefixed with a type (`feat`, `fix`, `chore`, `ci`, `docs`, `refactor`, `test`, `build`, `perf`, `style`), optionally with a scope — e.g. `fix(wilbur): serve REST API without static files`. Keep titles short (roughly ≤ 72 chars).
114+
115+
After a blank line, add a very short brief (one or two sentences) explaining what the commit does and, if non-obvious, why. Skip the brief only for truly trivial commits (typo fixes, lockfile bumps).
116+
117+
Never add a `Co-Authored-By:` trailer. Commit messages should carry only the human author.

0 commit comments

Comments
 (0)