skilld
All skills
github avatar

/conventional-commit

@caab1f6 official
by githubgithub/awesome-copilot40k stars
5,040

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.

Ask your Agent

Use this Skill: https://skilld.dev/gh/github/awesome-copilot/conventional-commit

This session only. Nothing lands on disk.

SKILL.md

≈71 tokens always: the name and description. ≈584 when used: this file.

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>

Source: SKILL.md on GitHub

Third-party checks

2 warnings17d5 checks · Risk MEDIUM
  • Gen Agent Trust Hub17d

    The skill instructs the AI agent to execute git commands automatically without user confirmation, which attempts to bypass standard safety guardrails for shell execution. It also processes external data from git diffs, making it potentially susceptible to indirect prompt injection.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW · No issues

  • Runlayer7mo

    1/1 file flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at caab1f6. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 19 hours ago.

Activeupdated 7 months ago

Topics

  • Git/VCS
  • conventional-commits
  • commit-messages
  • workflow
  • prompt-template

README badge

README badge for github/awesome-copilot/conventional-commit

What it does

Guides AI agents to generate commit messages following the Conventional Commits specification, using a structured XML format for type, scope, description, body, and footer. Helps standardize commits with validation rules and examples across feat, fix, docs, refactor, and other commit types.

Generated from the current SKILL.md.

Frequently asked

Does this work with all conventional commit types?
Yes. The skill supports all standard types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, and revert, per the Conventional Commits specification.
Can I include a body and footer in my commit message?
Yes. The skill supports optional body and footer fields. Use the body for detailed explanation and the footer for breaking changes or issue references.
Is the scope required?
No, the scope is optional but recommended for clarity about which part of the codebase the change affects.
Does this automatically run the commit command?
Yes. After you construct the commit message, the skill automatically executes the git commit command in the integrated terminal without requiring confirmation.

Generated from the current SKILL.md. These answers refresh after source changes.