From 218b715dec5d3ea00d1f27f47abba83bcbb91199 Mon Sep 17 00:00:00 2001 From: Jason Heddings Date: Tue, 10 Mar 2026 11:49:10 -0600 Subject: [PATCH] chore: add commit and branch naming conventions to CLAUDE.md (#200) Co-authored-by: Claude Opus 4.6 --- CLAUDE.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index e385269..e3732ba 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -80,3 +80,27 @@ commits, tags with the format `obsidian-stomp-X.Y.Z`, and pushes. - Error handling at the controller level: strategies may throw, controller catches and shows `Notice` to the user - Prefer `document.querySelectorAll` + `compareDocumentPosition` for stable element ordering over offset-based approaches - When modifying settings interfaces, update `DEFAULT_SETTINGS` in main.ts to ensure backwards compatibility with existing user data + +## Commit Conventions + +Use [Conventional Commits](https://www.conventionalcommits.org/) format: + +``` +(): +``` + +Types: `feat`, `fix`, `chore`, `docs`, `refactor`, `test`, `style`, `perf` + +Scope is optional but encouraged (e.g. `fix(scroller): ...`, `feat(engine): ...`). + +Include the issue number when applicable (e.g. `feat: add section scroll (#8)`). + +## Branch Naming + +Use the same type prefixes as commits, followed by a short description: + +``` +/ +``` + +Examples: `feat/section-scroll`, `fix/animation-timing`, `chore/update-deps`