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.
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.
CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。
阅读排版
---
name: conventional-commit
description: '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.'
---
### Instructions
```xml
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:**
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 `.
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):
```bash
git commit -m "type(scope): description"
```
6. Just execute this prompt and Copilot will handle the commit for you in the terminal.
### Commit Message Structure
```xml
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
```xml
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
```xml
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
```xml
git commit -m "type(scope): description"
Replace with your constructed message. Include body and footer if needed.
```