git-commit-brief

Standardize local git commit messages to Conventional Commits format.

34|12|Updated Aug 1, 2021
One-click install
npx skills add https://github.com/pear-studio/nonebot-dicepp --skill git-commit-brief
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit-brief
Source: https://github.com/pear-studio/nonebot-dicepp/tree/main/docs/agent/skills/git-commit-brief
Command: npx skills add https://github.com/pear-studio/nonebot-dicepp --skill git-commit-brief

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Git commit messages often become inconsistent or vague, making it hard to understand what changed and why when reviewing history.

Core Features & Use Cases

  • Conventional Commits enforcement: Standardizes commit format as <type>(<scope>): <subject> with required type and scope.
  • Scope vocabulary guidance: Helps choose the correct scope such as core, module, test, dev, agent, or docs.
  • Safety rules for message content: Prevents process-oriented or low-value details (like review steps or backlog IDs) from polluting commit history.

Quick Start

Ask the skill to generate a commit message that follows Conventional Commits for your local change, including the correct type and scope and a one-line subject describing the actual code change.

Frequently Asked Questions about git-commit-brief

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

FAQPage Schema
How do I write conventional commit messages for local git changes?

To write conventional commit messages, format them as `<type>(<scope>): <subject>` with a required type and lowercase scope. This standard keeps your git commit history readable and actionable for day-to-day codebase documentation.

What is the correct scope to use in a conventional commit?

The correct scope in a conventional commit is a lowercase identifier such as `core`, `module`, `test`, `dev`, `agent`, or `docs`. Selecting a valid scope helps categorize the specific area of the codebase your commit targets.

How do I avoid low-value details in my git commit history?

To avoid low-value details in your git commit history, exclude process-oriented metadata like review steps or backlog task IDs. Focus the commit subject on describing the actual code change and its outcome.

Can I use conventional commits for documentation and test changes?

Yes, you can use conventional commits for documentation and test changes across your codebase. Standardizing the commit format works for day-to-day development across code, docs, tests, and agent-related changes.

What is the best way to standardize an outcome-focused commit subject?

The best way to standardize an outcome-focused commit subject is to describe what the code change actually achieves. Avoid process metadata and ensure the format follows the `<type>(<scope>): <subject>` structure for consistency.