docs(instructions): add conventional commit prompt and document in RE… (#131)
* 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
GitHub
parent
43579c939e
commit
3ef7117151
@ -31,6 +31,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Blazor](instructions/blazor.instructions.md) | Blazor component and application patterns | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fblazor.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fblazor.instructions.md) |
|
||||
| [Cmake Vcpkg](instructions/cmake-vcpkg.instructions.md) | C++ project configuration and package management | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md) |
|
||||
| [Containerization & Docker Best Practices](instructions/containerization-docker-best-practices.instructions.md) | Comprehensive best practices for creating optimized, secure, and efficient Docker images and managing containers. Covers multi-stage builds, image layer optimization, security scanning, and runtime best practices. | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcontainerization-docker-best-practices.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcontainerization-docker-best-practices.instructions.md) |
|
||||
| [Conventional Commit](instructions/conventional-commit.prompt.md) | 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. | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) |
|
||||
| [Copilot Process tracking Instructions](instructions/copilot-thought-logging.instructions.md) | See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md) |
|
||||
| [C# Development](instructions/csharp.instructions.md) | Guidelines for building C# applications | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp.instructions.md) |
|
||||
| [DevOps Core Principles](instructions/devops-core-principles.instructions.md) | Foundational instructions covering core DevOps principles, culture (CALMS), and key metrics (DORA) to guide GitHub Copilot in understanding and promoting effective software delivery. | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevops-core-principles.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevops-core-principles.instructions.md) |
|
||||
|
||||
73
instructions/conventional-commit.prompt.md
Normal file
73
instructions/conventional-commit.prompt.md
Normal 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>
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user