Conventional Commits
Construct a one-line commit subject that passes the commit-msg and tracker-commit-msg hooks on the first attempt. For staging and diff splits, read the git reference of cli-tools. For tracker records, use work-tracker.
Rules
- Use
basicly commitby default. - Write the description in lowercase letters, digits, spaces and hyphens only. The hook rejects every other character, also in proper nouns and acronyms.
- Put a version, a file name or a capitalised name in the body. The hooks check only the subject line.
- Use the id of a record the ledger holds;
work-trackerfiles it and stages the ledger. - After a refusal, read the hook's output first. It names the offending character or the missing record; fix that, not a guess.
- Read
git status --shortcolumn 1 before you commit.git committakes the whole index, including a file staged by a refused attempt.
Read when needed
- Before composing a subject by hand or using command overrides, read message format and command options.
- For valid/invalid subjects, a refusal or hook installation details, read examples and enforcement.