AutoGineer
Generated banner for Conventional Commit
Generated logo for Conventional Commit

Conventional Commit

GitHubOfficialOriginally contributed by @danchev as prompts/conventional-commit.prompt.md; moved into a skill by pull request #761Distributed by GitHub

  • Skill
  • Workflow
  • Software development
  • MIT
  • No issues found
Download ZIP

From the author

Prompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation.
— the description by danchev

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a systematic approach to writing commit messages that adhere to the Conventional Commits specification. By utilizing a structured XML-based template, it guides users through defining the commit type, scope, description, body, and footer. The workflow integrates directly with Git operations, ensuring that version control history remains consistent, readable, and machine-parsable.

What it does

  • Provides a standardized XML template for commit message construction.
  • Defines allowed commit types such as feat, fix, refactor, and chore.
  • Guides users through the Git staging and commit process.
  • Enforces the use of imperative mood for commit descriptions.
  • Supports the inclusion of optional bodies and footers for breaking changes or issue references.

When to use it

  • When you need to maintain a clean and consistent Git commit history.
  • When working in teams that require standardized commit messages for automated changelog generation.
  • When you want to ensure all commit messages follow the Conventional Commits specification.
  • When you need a structured way to document breaking changes or link commits to specific issues.

Advantages

  • Improves readability and maintainability of project history.
  • Facilitates automated release notes and versioning.
  • Reduces ambiguity in commit logs by enforcing a clear structure.
  • Helps developers remember to include essential context like breaking changes.

Usage examples

“Help me write a commit message for adding a new login feature.”
The agent provides the XML template populated with 'feat(auth): add user login functionality' and guides the user to execute the commit command.
“I need to fix a bug in the UI component, how should I format the commit?”
The agent suggests 'fix(ui): resolve button alignment issue' and explains how to stage the changes before committing.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/github/conventional-commit/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip conventional-commit.zip -d .agents/skills

Documentation by danchev

Instructions
	<description>This file contains a prompt template for generating conventional commit messages. It provides instructions, examples, and formatting guidelines to help users write standardized, descriptive commit messages in accordance with the Conventional Commits specification.</description>
Workflow

Follow these steps:

  1. Run git status to review changed files.

  2. Run git diff or git diff --cached to inspect changes.

  3. Stage your changes with git add <file>.

  4. Construct your commit message using the following XML structure.

  5. After generating your commit message, Copilot will automatically run the following command in your integrated terminal (no confirmation needed):

git commit -m "type(scope): description"

  1. Just execute this prompt and Copilot will handle the commit for you in the terminal.

Commit Message Structure
<commit-message>
	<type>feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert</type>
	<scope>()</scope>
	<description>A short, imperative summary of the change</description>
	<body>(optional: more detailed explanation)</body>
	<footer>(optional: e.g. BREAKING CHANGE: details, or issue references)</footer>
</commit-message>
Examples
<examples>
	<example>feat(parser): add ability to parse arrays</example>
	<example>fix(ui): correct button alignment</example>
	<example>docs: update README with usage instructions</example>
	<example>refactor: improve performance of data processing</example>
	<example>chore: update dependencies</example>
	<example>feat!: send email on registration (BREAKING CHANGE: email service required)</example>
</examples>
Validation
<validation>
	<type>Must be one of the allowed types. See <reference>https://www.conventionalcommits.org/en/v1.0.0/#specification</reference></type>
	<scope>Optional, but recommended for clarity.</scope>
	<description>Required. Use the imperative mood (e.g., "add", not "added").</description>
	<body>Optional. Use for additional context.</body>
	<footer>Use for breaking changes or issue references.</footer>
</validation>
Final Step
<final-step>
	<cmd>git commit -m "type(scope): description"</cmd>
	<note>Replace with your constructed message. Include body and footer if needed.</note>
</final-step>

Files

Requirements and compatibility

Written for: GitHub Copilot

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs a command-line tool

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Originally contributed by
GitHub avatar of danchev@danchevas prompts/conventional-commit.prompt.mdmoved into a skill by pull request #761
Publisher
GitHub (Official)
Distributed by
GitHub
Source
github/awesome-copilot · skills/conventional-commit · commit 797337f
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Contributors
StevenJV, danchev, jpinz

AutoGineer is not affiliated with or endorsed by danchev or GitHub.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download conventional-commit.zip