CockroachDB Commit Helper
Help the user create properly formatted commit messages and release notes that follow CockroachDB conventions.
Workflow
- Analyze the changes: Run
git diff --staged or git diff to understand what was modified
- Determine the package prefix: Identify the primary package affected
- Ask the user for:
- Issue/epic number if not already known
- Whether release notes are needed and what category fits best
- Write the subject line: Imperative mood, no period, under 72 characters
- Write the body: Explain the before/after, why the change was needed
- Add issue references: Include Resolves/Epic as appropriate
- Write the release note: Clear, user-focused description of the change
- Create the commit using the properly formatted message
Commit Message Structure