Name: conventional-commit
Author: lightspeedwp

Prompt file imported from lightspeedwp/utils (.github/prompts/conventional-commit.prompt.md). Copyright stays with the author.

Instructions

 <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:

Run git status to review changed files.
Run git diff or git diff --cached to inspect changes.
Stage your changes with git add <file>.
Construct your commit message using the following XML structure.
After generating your commit message, Copilot will automatically run the following command in your integrated terminal (no confirmation needed):

git commit -m "type(scope): description"

Just execute this prompt and Copilot will handle the commit for you in the terminal.

Commit Message Structure

<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

<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

<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

<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>

### 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" ``` 1. 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> ```

{ "prompt": "### Instructions\n\n```xml\n <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>\n <note>\n```\n\n### Workflow\n\n**Follow these steps:**\n\n1. Run `git status` to review changed files.\n2. Run `git diff` or `git diff --cached` to inspect changes.\n3. Stage your changes with `git add <file>`.\n4. Construct your commit message using the following XML structure.\n5. After generating your commit message, Copilot will automatically run the following command in your integrated terminal (no confirmation needed):\n\n```bash\ngit commit -m \"type(scope): description\"\n```\n\n1. Just execute this prompt and Copilot will handle the commit for you in the terminal.\n\n### Commit Message Structure\n\n```xml\n<commit-message>\n <type>feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert</type>\n <scope>()</scope>\n <description>A short, imperative summary of the change</description>\n <body>(optional: more detailed explanation)</body>\n <footer>(optional: e.g. BREAKING CHANGE: details, or issue references)</footer>\n</commit-message>\n```\n\n### Examples\n\n```xml\n<examples>\n <example>feat(parser): add ability to parse arrays</example>\n <example>fix(ui): correct button alignment</example>\n <example>docs: update README with usage instructions</example>\n <example>refactor: improve performance of data processing</example>\n <example>chore: update dependencies</example>\n <example>feat!: send email on registration (BREAKING CHANGE: email service required)</example>\n</examples>\n```\n\n### Validation\n\n```xml\n<validation>\n <type>Must be one of the allowed types. See <reference>https://www.conventionalcommits.org/en/v1.0.0/#specification</reference></type>\n <scope>Optional, but recommended for clarity.</scope>\n <description>Required. Use the imperative mood (e.g., \"add\", not \"added\").</description>\n <body>Optional. Use for additional context.</body>\n <footer>Use for breaking changes or issue references.</footer>\n</validation>\n```\n\n### Final Step\n\n```xml\n<final-step>\n <cmd>git commit -m \"type(scope): description\"</cmd>\n <note>Replace with your constructed message. Include body and footer if needed.</note>\n</final-step>\n```", "variables": [], "notes": "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.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/lightspeedwp/utils", "path": ".github/prompts/conventional-commit.prompt.md", "ref": "cd6f313161786a17f51718c94d58d65310f06e57", "url": "https://github.com/lightspeedwp/utils/blob/cd6f313161786a17f51718c94d58d65310f06e57/.github/prompts/conventional-commit.prompt.md", "key": "lightspeedwp/utils/.github/prompts/conventional-commit.prompt.md" } } }

conventional-commit

About

Instructions

Workflow

Commit Message Structure

Examples

Validation

Final Step

Use it

Manifest

Reviews