conventional-commit

작성자: github

표준화된 컨벤셔널 커밋 메시지 생성을 위한 구조화된 프롬프트 템플릿입니다. 변경 사항 스테이징, diff 검사, 타입, 범위, 설명, 본문, 푸터 필드로 커밋을 구성하는 과정을 안내하는 XML 형식의 워크플로우를 제공합니다. 허용된 타입(feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert)과 함께 Conventional Commits 사양 준수를 강제하는 검증 규칙을 포함합니다. 일반적인 커밋 패턴을 다루는 6가지 실용적인 예제를 제공합니다.

npx skills add https://github.com/github/awesome-copilot --skill conventional-commit

ZIP 다운로드 GitHub

35.8k

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:

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):

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

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>