What problem does it solve?
Safe commits in multi-contributor environments ensure changes are intentional, reviewed, and properly attributed to contributors, preventing accidental or conflicting changes.
Core Features & Use Cases
- Pre-flight checks: Inspect what will be committed and ensure only intended changes are included.
- Review staged changes: Validate the staged set before committing to avoid cross-contributor churn.
- Structured commit messages: Enforce a multi-part message format including motivation, UX change, and architecture notes.
- Use Case: In a busy repo, run the script to commit a ticket with a descriptive title and a detailed message, preserving history and co-authorship.
Quick Start
Use the commit.sh script to create a safe, structured commit in your git repo, e.g.:
bash path/to/commit.sh "<title>" "<motivation>" "<ux-change>" "<arch-change>" [files...]