-
Notifications
You must be signed in to change notification settings - Fork 478
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
docs(instructions): add conventional commit prompt and document in RE… #131
Conversation
There was a problem hiding this 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.
@@ -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'] |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this 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.
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]>
Pull Request Checklist
node update-readme.js
and verified thatREADME.md
is up to date.Description
Type of Contribution
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.