This VS Code extension shows a modal reminder when Git opens .git/COMMIT_EDITMSG without a user message, prompting the user to type a commit message in the built-in editor.
Commands
- Git Commit Reminder: Reset Reminder State
- Command id:
gitCommitReminder.resetReminderState - Clears lifetime reminder count and temporary snooze counters.
- Command id:
Settings
gitCommitReminder.enableCommitMessageReminder(default: true)- When Git opens
.git/COMMIT_EDITMSG, the extension shows a native modal warning and keeps the regular editor open for typing the message.
- When Git opens
Development
- Install dependencies:
npm install
- Compile:
npm run compile
- Run extension for testing:
- Press F5 in VS Code to start an Extension Development Host.
Git commit reminder behavior
When gitCommitReminder.enableCommitMessageReminder is enabled:
- Git opens
.git/COMMIT_EDITMSG. - Extension detects the file open event.
- Extension shows a native modal warning dialog.
- User types commit text directly in the opened COMMIT_EDITMSG editor.
- User confirms the dialog and proceeds with commit again.
Reminder policy:
- The modal is counted in persistent lifetime state.
- Before 5 total reminders: only
OKis shown. - At 5 reminders and after: an additional
Got it, don't remind mebutton appears. - Choosing
Got it, don't remind mesuppresses the next 5 reminder opportunities. - After those 5 skipped opportunities are consumed, reminders automatically resume with the same disable option available.
Commit editor modality note
The commit warning uses VS Code's native modal message API (showWarningMessage with modal: true).