mirror of
https://github.com/tiennm99/blog.git
synced 2026-10-13 02:14:29 +00:00
feat(skills): add conventional-commit skill for standardized commit messages
Adds the conventional-commit skill from awesome-copilot to help generate standardized, descriptive commit messages following the Conventional Commits specification. Includes workflow instructions, examples, and validation guidelines.
This commit is contained in:
tiennm99 committed
1 parent
4bb7f32754
commit
0aa72e6e08
3 files changed
+154
No files matched your search
@@ -0,0 +1,72 @@
|
||||
---
|
||||
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
|
||||
<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):
|
||||
|
||||
```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
|
||||
<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
|
||||
|
||||
```xml
|
||||
<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
|
||||
|
||||
```xml
|
||||
<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
|
||||
|
||||
```xml
|
||||
<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>
|
||||
```
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
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
|
||||
<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):
|
||||
|
||||
```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
|
||||
<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
|
||||
|
||||
```xml
|
||||
<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
|
||||
|
||||
```xml
|
||||
<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
|
||||
|
||||
```xml
|
||||
<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>
|
||||
```
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"version": 1,
|
||||
"skills": {
|
||||
"conventional-commit": {
|
||||
"source": "github/awesome-copilot",
|
||||
"sourceType": "github",
|
||||
"computedHash": "f29c9486cede6c7b2df0cfb0a2e4aa67446552b991bcf17d1b309e903171f03d"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user