commit-helper
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 --stagedorgit diffto 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
More from cockroachdb/cockroach
backport-pr-assistant
Help backport PRs to release branches using the backport CLI tool. Use when backporting changes that have merge conflicts requiring manual resolution.
75reduce-unoptimized-query-oracle
Reduce an unoptimized-query-oracle test failure log to the simplest possible reproduction case. Use when you have unoptimized-query-oracle*.log files from a failed roachtest and need to find the minimal SQL to reproduce the bug.
63engflow-artifacts
Use when downloading test logs, artifacts, or outputs.zip from EngFlow build invocations. Use when investigating CockroachDB CI test failures hosted on mesolite.cluster.engflow.com.
29table-driven-test
Guidelines for creating clean, well-structured table-driven tests in Go following CockroachDB conventions.
26integration-test
Guidelines for writing integration tests with CockroachDB test servers, including when to use them and how to use sqlutils.
18bump-cluster-ui
Bump cluster-ui package version after a release branch cut. Creates two PRs — one to drop the prerelease suffix on the release branch and one to increment the minor version on master.
3