Help create git commits and PRs with properly formatted messages and release notes following CockroachDB conventions. Use when committing changes or creating pull requests.
npxskills add cockroachdb/cockroach--skill commit-helperLoading…
Help the user create properly formatted commit messages and release notes that follow CockroachDB conventions.
git diff --staged or git diff to understand what was modifiedBasic Format:
package: imperative title without period
Detailed explanation of what changed, why it changed, and
how it impacts users. Explain the problem that existed
before and how this commit solves it.
Include context about alternate approaches considered and
any side effects or consequences.
Resolves: #123
Epic: CRDB-357
Release note (category): Description of user-facing change
in past or present tense explaining what changed, how users
can see the change, and why it's important.
Key Requirements:
When to include release notes:
When to exclude release notes:
crdb_internal.Valid Categories:
backward-incompatible change - Breaking changes to stable interfacesenterprise change - Features requiring enterprise licenseops change - Commands/endpoints for operators (logging, metrics, CLI flags)cli change - Commands for developers/contributors (SQL shells, debug tools)sql change - SQL statements, functions, system catalogsui change - DB Console changessecurity update - Security feature changesperformance improvement - Performance enhancementscluster virtualization - Multi-tenancy infrastructurebug fix - Problem fixesgeneral change - Changes that don't fit elsewherebuild change - Source build requirementsDescription guidelines:
Examples:
Good bug fix:
Release note (bug fix): Fixed a bug introduced in v19.2.3 that
caused duplicate rows in CREATE TABLE ... AS results when multiple
nodes attempt to populate the results.
Good feature:
Release note (enterprise change): Shortened the default interval
for the kv.closed_timestamp.target_duration cluster setting from
30s to 3s. This allows follower reads at 4.8 seconds in the past,
a much shorter window than the previous 48 seconds.
Resolves: #123 - Auto-closes issue on PR mergeSee also: #456, #789 - Cross-references issuesEpic: CRDB-357 - Links to epicbackward-incompatible change category for any breaking changes
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).