Commit Message
Overview
Create a clean git commit by staging the right changes and writing a concise subject with a useful body.
Workflow
- •Check status with
git status -sb. If the working tree is clean, report that nothing needs committing. - •Review diffs (
git diffandgit diff --staged) to understand what changed and why. - •Stage the intended changes. Prefer selective adds, but use
git add -Aif everything should be included. - •Write the commit message:
- •Subject: imperative mood, <= 72 chars, summarize the main change.
- •Body: one blank line, then short paragraphs or bullets covering why the change was made, key details, and user impact.
- •Add a final
Tests:line (e.g.,Tests: not runorTests: pytest).
- •Commit with
git commit -m "subject" -m "body". - •Confirm with
git log -1and report the commit hash and subject.