Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

AungMyoKyaw
Copy link
Contributor

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run node update-readme.js and verified that README.md is up to date.

Description

Screenshot 2025-07-28 at 10 29 57 AM ---

Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • Other (please specify):

Additional Notes


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

@Copilot Copilot AI review requested due to automatic review settings July 28, 2025 03:32
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new conventional commit prompt file to help users generate standardized commit messages following the Conventional Commits specification. The prompt provides a structured XML format with instructions, examples, and validation guidelines.

  • Adds a new prompt file for generating conventional commit messages
  • Updates the README.md to include the new conventional commit prompt
  • Provides structured workflow and examples for consistent commit message formatting

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
instructions/conventional-commit.prompt.md New prompt file providing XML-structured templates and guidelines for conventional commit messages
README.md Added table entry for the conventional commit prompt with installation links

…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.
@AungMyoKyaw AungMyoKyaw requested a review from aaronpowell July 29, 2025 15:32
@@ -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']
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find these tools in VS Code - can you verify that the tools are correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-07-31 at 5 00 45 PM Screenshot 2025-07-31 at 5 00 58 PM

hello @aaronpowell ,
I just have attached the screenshots.

Copy link
Contributor

@aaronpowell aaronpowell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting note on the tool names - there seems to be a difference between what you get from the picker and what it might be running.

@aaronpowell aaronpowell merged commit 3ef7117 into github:main Aug 1, 2025
2 checks passed
AungMyoKyaw added a commit to AungMyoKyaw/awesome-copilot that referenced this pull request Aug 1, 2025
github#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 <[email protected]>
@AungMyoKyaw AungMyoKyaw deleted the feat/conventional-commit-prompt branch August 2, 2025 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants