Labsco
github logo

conventional-commit

✓ Official36,200

by github · part of github/awesome-copilot

Structured prompt template for generating standardized conventional commit messages. Provides XML-formatted workflow guiding users through staging changes, inspecting diffs, and constructing commits with type, scope, description, body, and footer fields Includes validation rules enforcing Conventional Commits specification compliance, with allowed types (feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert) Offers six practical examples covering common commit patterns,...

🔥🔥🔥✓ VerifiedFreeQuick setup
🧩 One of 7 skills in the github/awesome-copilot package — works on its own, and pairs well with its siblings.

Structured prompt template for generating standardized conventional commit messages. Provides XML-formatted workflow guiding users through staging changes, inspecting diffs, and constructing commits with type, scope, description, body, and footer fields Includes validation rules enforcing Conventional Commits specification compliance, with allowed types (feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert) Offers six practical examples covering common commit patterns,...

Inspect the full instructions your agent will receiveExpand

This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.

by github

Structured prompt template for generating standardized conventional commit messages. Provides XML-formatted workflow guiding users through staging changes, inspecting diffs, and constructing commits with type, scope, description, body, and footer fields Includes validation rules enforcing Conventional Commits specification compliance, with allowed types (feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert) Offers six practical examples covering common commit patterns,... npx skills add https://github.com/github/awesome-copilot --skill conventional-commit Download ZIPGitHub36.2k

Instructions

Copy & paste — that's it
 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. 

Workflow

Follow these steps:

  • Run git status to review changed files.

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

  • Stage your changes with git add <file>.

  • Construct your commit message using the following XML structure.

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

Copy & paste — that's it
git commit -m "type(scope): description"
  • Just execute this prompt and Copilot will handle the commit for you in the terminal.

Commit Message Structure

Copy & paste — that's it
 
 feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert 
 () 
 A short, imperative summary of the change 
 (optional: more detailed explanation) 
 (optional: e.g. BREAKING CHANGE: details, or issue references) 
 

Examples

Copy & paste — that's it
 
 feat(parser): add ability to parse arrays 
 fix(ui): correct button alignment 
 docs: update README with usage instructions 
 refactor: improve performance of data processing 
 chore: update dependencies 
 feat!: send email on registration (BREAKING CHANGE: email service required) 
 

Validation

Copy & paste — that's it
 
 Must be one of the allowed types. See https://www.conventionalcommits.org/en/v1.0.0/#specification 
 Optional, but recommended for clarity. 
 Required. Use the imperative mood (e.g., "add", not "added"). 
 Optional. Use for additional context. 
 Use for breaking changes or issue references. 
 

Final Step

Copy & paste — that's it
 
 git commit -m "type(scope): description" 
 Replace with your constructed message. Include body and footer if needed.