skills.rest
cockroachdb
cockroachdbOFFICIAL
Explore all skills by this author →
WebsiteGitHub

commit-helper

Generate Git commit messages and pull request descriptions following CockroachDB conventions.

32.4k|4.1k|Updated Feb 6, 2014
Search Tags:#git#developer tools#pull request#commit#release notes#code convention
One-click install
npx skills add https://github.com/cockroachdb/cockroach --skill commit-helper-cockroachdb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit-helper
Source: https://github.com/cockroachdb/cockroach/tree/main/.claude/skills/commit-helper
Command: npx skills add https://github.com/cockroachdb/cockroach --skill commit-helper-cockroachdb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of creating Git commits and pull requests by ensuring adherence to the CockroachDB's specific formatting conventions for messages and release notes.

Core Features & Use Cases

  • Automated Formatting: Generates correctly structured commit messages and PR descriptions.
  • Release Note Generation: Assists in writing clear, user-focused release notes with appropriate categorization.
  • Convention Enforcement: Helps maintain consistency and quality across the project's commit history.
  • Use Case: When you've finished a bug fix, use this Skill to help you write a commit message that includes the package, a clear description of the fix, the issue it resolves, and a concise release note for the next patch release.

Quick Start

Use the commit-helper skill to generate a commit message for your changes.

Frequently Asked Questions about commit-helper

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a Git commit message that follows CockroachDB conventions?▼

Writing a CockroachDB commit message involves structuring the message with an imperative subject line, a detailed body, the affected package name, issue references, and categorized release notes.

What is the correct format for CockroachDB release notes in a pull request?▼

The correct format for CockroachDB release notes requires writing clear, user-focused descriptions with appropriate categorization to ensure changes are properly documented for the next patch or feature release.

Can I use commit-helper to generate pull request descriptions for bug fixes?▼

Yes, you can use commit-helper to generate pull request descriptions for bug fixes by guiding you to include the affected package, a clear description of the fix, the resolved issue, and a concise release note.

How do you structure an imperative subject line for Git commits?▼

Structuring an imperative subject line for Git commits involves starting with a command verb to directly specify what the commit does, which is enforced to maintain consistency across the project's commit history.

What should be included in a CockroachDB pull request description?▼

A CockroachDB pull request description should include the affected package, a detailed body explaining the changes, specific issue references, and properly categorized release notes to maintain project quality.

Related Skills

Explore More Software Engineering Skills→
navidemadnavidemad

publish

Generate conventional commit messages and GitHub pull request descriptions.

Community
Intermediate
TashanGKDTashanGKD
5

git-commit-conventions

Normalize and validate Git commits and pull requests against conventional commit standards.

Official
Advanced
cbbkrd-techcbbkrd-tech

ln-742-precommit-setup

Configure Git hooks with Husky, lint-staged, commitlint, and pre-commit.

Community
Advanced
minusfiveminusfive
5

pr-guidelines

Enforce project-specific Git guidelines for branch pushes and pull requests.

Community
Basic