Commit Message Generator
Instructions
- •Run
git statusto check for all changes (staged, unstaged, untracked) - •If there are unstaged or untracked files, run
git add -Ato stage all changes - •Run
git diff --stagedto see what will be committed - •If no changes to commit, inform the user and stop
Pre-commit Checks
- •
Run lint and test checks before committing:
- •Run
cargo fmt --checkto check formatting - •Run
cargo clippy -- -D warningsto check for lint errors - •Run
cargo testto run tests
- •Run
- •
If any checks fail:
- •For formatting issues: Run
cargo fmtto auto-fix - •For clippy warnings: Read the affected files and fix the issues
- •For test failures: Investigate and fix the failing tests
- •After fixes, run
git add -Ato stage the fixes - •Re-run the failed checks to verify fixes
- •For formatting issues: Run
- •
Once all checks pass, generate a commit message following the rules below
- •
Run
git commit -m "message"immediately (no confirmation needed)
Format
- •Line 1: Summary (max 50 chars, imperative mood)
- •Line 2: Blank
- •Line 3+: Description (optional, explain what and why)
Rules
- •Write in English
- •Use imperative mood: "Add", "Fix", "Change" (not "Added", "Fixed")
- •NO prefixes like feat:, fix:, docs:
- •Be specific, avoid vague messages
Examples
❌ Bad
- •Fix
- •Bug fix
- •Various changes
✅ Good
- •Change audio capture buffer size to 20ms
- •Add retry logic for P2P connection failures
- •Remove unused audio codec parameters