ossappscollective Generating Commit Messages
Mandatory Process
BEFORE ANY git commit COMMAND:
- ALWAYS run
git diff --stagedfirst to see changes - ALWAYS analyze the staged changes thoroughly
- ALWAYS split the code changes into atomic commits, one per coherent / cohesive change. Tests for a change should be in the same commit as the change itself. A single feature spanning multiple files (module + view + test) is ONE cohesive change — do not split it by file. Only split when changes are truly unrelated (e.g. a bug fix + a new feature + a docs update)
- ALWAYS run the checks relevant to the change before committing (there are no
test/lint/formatscripts — invoke the binaries withnpx;yarn vitest/yarn eslint/yarn prettierfail on Yarn 4):- Tests:
npx vitest run <path>when a*.test.tscovers the change (isolate with a path or-t '<name>') - Types/Svelte:
yarn svelte-checkwhen.svelte/.tstyping is affected (this one is a real script) - Lint:
npx eslint <changed files>
- Tests:
- ALWAYS generate a commit message following the format below
- NEVER commit automatically as a side effect of making code changes. Only commit when the user explicitly invokes the commit skill or says "commit".
Confirmation Before Committing
--auto (caller runs autonomously): skip all approval/confirmation waits here (commit-plan gate below + fixup/rebase) — commit directly. Diff review, atomic splitting, checks, message format unchanged.
User trust requires seeing the plan before execution. Always present the full commit plan and wait for explicit approval before running any git commit command.
For each commit (regular or fixup), present:
- The commit message (header + body if applicable)
- The list of files included
- If splitting into multiple commits: the full split plan (which files go in which commit, in what order)
- If fixup: which commit SHA it targets and why
Then ask the user to confirm. Do not proceed until they approve. If they request changes to the message or grouping, adjust and re-present.
This applies equally to regular commits, fixups, and any commits triggered during the open-pr workflow.
Auto-Fixup Detection
Before creating a new commit, check whether the staged changes should be fixup'd into a recent commit on the current branch.
Process:
- Run
git log main..HEAD --onelineto list all commits on the branch since diverging from main - For each staged file, check
git log main..HEAD -- <file>to see if it was modified in a recent branch commit - If a staged change clearly amends or extends code from a previous commit (same file, nearby lines, related logic — e.g. fixing a typo introduced in a prior commit, adding a missing import for a recently added module), suggest fixup'ing into that commit
- Present the suggestion: "This change to
<file>looks like it should be fixup'd into<sha> <message>. Want me to fixup instead of creating a new commit?"
When fixup is confirmed:
- Run
git commit --fixup=<sha>(with user confirmation) - Then run
GIT_SEQUENCE_EDITOR=true git rebase --interactive --autosquash mainto squash immediately (with user confirmation before the rebase)
If the change doesn't clearly relate to a previous commit, proceed with a normal new commit.
Required Commit Message Format
This repo uses Conventional Commits (enforced by the @commitlint/config-conventional config inline in package.json). The format is fixed:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory; scope, body, and footer are optional.
Header
Shape: <type>(<scope>): <subject>
<type>is one of:buildcidocsfeatfixfix-nextperfrefactorreleasestyletest<scope>(optional) is the affected area — usually a feature underapp/components/or a service underapp/services/(e.g.ocr,pdf,camera,sync,settings,security,edit,pkpass). When a change is platform-specific, prefix the scope with the platform:android/sync,ios/camera<subject>: imperative present tense ("change" not "changed"), lowercase first letter, no trailing period- No line may exceed 100 characters
Examples:
docs(README): add build setup steps for submodules
fix(ios/camera): correct preview orientation on rotation
Body
ONLY add a body when the header alone isn't enough for a reviewer:
- Use the imperative present tense, same as the subject
- Explain WHAT changed only if the commit touches more than 3 files
- Explain WHY — the motivation, contrasted with previous behavior
- Keep every line under 100 characters
Footer
- Reference the issue this commit closes:
Fixes #<issue>/Closes #<issue> - Breaking changes start with
BREAKING CHANGE:followed by a description and migration path
Revert
A commit that reverts another begins with revert: followed by the reverted header. The body states This reverts commit <hash>.
Co-Authored-By
Only add a Co-Authored-By trailer when Claude actually wrote the code being committed. If the user wrote the changes themselves (and Claude is just committing), do not add it.