Awesome/awesome-copilot
1
0
Fork 0
mirror of https://github.com/github/awesome-copilot.git synced 2026-02-22 19:35:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(instructions): add conventional commit prompt and document in RE… (#131)

Browse Source 
* docs(instructions): add conventional commit prompt and document in README

* docs(readme,conventional-commit-prompt): clarify Conventional Commit prompt description and improve prompt front matter

Updated README.md to clarify the Conventional Commit prompt description and details. Updated instructions/conventional-commit.prompt.md to improve front matter (description, tools) and remove unnecessary fields.

* docs(prompt): simplify XML structure and remove redundant tags

---------

Co-authored-by: Aung Myo Kyaw <aungmyokyaw@users.noreply.github.com>
This commit is contained in:
Aung Myo Kyaw
2025-08-01 08:45:34 +07:00
committed by GitHub
parent 43579c939e
commit 3ef7117151
2 changed files with 74 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
instructions/conventional-commit.prompt.md Normal file
View File

@@ -0,0 +1,73 @@
---
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.'
tools: ['run_in_terminal', 'get_terminal_output']
---
### 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>
<note>
```
### 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>
```