commit-helper

Generate CockroachDB-convention commit messages and release notes.

1|Updated Jan 29, 2026
One-click install
npx skills add https://github.com/AngelP17/factoryops-console --skill commit-helper-angelp17
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-helper
Source: https://github.com/AngelP17/factoryops-console/tree/main/factoryops-console/.agent/skills/commit-helper
Command: npx skills add https://github.com/AngelP17/factoryops-console --skill commit-helper-angelp17

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you create git commits and PR notes that adhere to CockroachDB conventions, ensuring clear, consistent messaging.

Core Features & Use Cases

  • Structured commit messages: Generate subject lines and detailed bodies that explain changes, rationale, and impact.
  • Release notes automation: Produce release notes with proper categorization and references to issues/epics.
  • Workflow guidance: Step-by-step instructions from change analysis to creating the final commit.

Quick Start

Use the commit-helper to assemble a properly formatted commit for the current change, including subject, body, release note, and references.

Frequently Asked Questions about commit-helper

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

FAQPage Schema
How do I write commit messages that follow CockroachDB conventions?

CockroachDB commit conventions require a structured format: a subject line capped at 72 characters, a detailed body explaining changes and rationale, issue references, and a categorized release note. commit-helper guides you through each section, enforcing proper indentation and structure to keep commits consistent and readable.

Can I automate release notes generation from my commits?

Yes. commit-helper produces release notes with proper categorization and issue/epic references directly from your commit data. It analyzes your changes and packages them into formatted release notes that follow CockroachDB standards, eliminating manual note writing.

What's the step-by-step process for creating a formatted commit with this tool?

commit-helper walks you through: analyzing your change, categorizing it, adding issue references, writing a subject line (72 characters max), composing a detailed body, and generating a release note. Each step enforces CockroachDB formatting rules before producing your final commit message.

Does this work with pull request workflows?

Yes. commit-helper supports both commit and PR workflows, helping you structure PR notes alongside commit messages. It ensures your PR documentation adheres to the same CockroachDB conventions as your commits, maintaining consistency across your codebase.

What formatting rules does the tool enforce?

commit-helper enforces CockroachDB conventions: 72-character subject line limit, structured body sections, proper indentation, categorized release notes, and issue/epic reference formatting. It prevents commits that don't meet these standards.

Can I use commit-helper across different codebases?

Yes. commit-helper applies CockroachDB commit and release-note conventions to any codebase, guiding teams through consistent message formatting regardless of project. It's designed to standardize commit practices across multiple repositories.