|
| 1 | +--- |
| 2 | +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.' |
| 3 | +tools: ['run_in_terminal', 'get_terminal_output'] |
| 4 | +--- |
| 5 | + |
| 6 | +### Instructions |
| 7 | + |
| 8 | +```xml |
| 9 | + <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> |
| 10 | + <note> |
| 11 | +``` |
| 12 | + |
| 13 | +### Workflow |
| 14 | + |
| 15 | +**Follow these steps:** |
| 16 | + |
| 17 | +1. Run `git status` to review changed files. |
| 18 | +2. Run `git diff` or `git diff --cached` to inspect changes. |
| 19 | +3. Stage your changes with `git add <file>`. |
| 20 | +4. Construct your commit message using the following XML structure. |
| 21 | +5. After generating your commit message, Copilot will automatically run the following command in your integrated terminal (no confirmation needed): |
| 22 | + |
| 23 | +```bash |
| 24 | +git commit -m "type(scope): description" |
| 25 | +``` |
| 26 | + |
| 27 | +6. Just execute this prompt and Copilot will handle the commit for you in the terminal. |
| 28 | + |
| 29 | +### Commit Message Structure |
| 30 | + |
| 31 | +```xml |
| 32 | +<commit-message> |
| 33 | + <type>feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert</type> |
| 34 | + <scope>()</scope> |
| 35 | + <description>A short, imperative summary of the change</description> |
| 36 | + <body>(optional: more detailed explanation)</body> |
| 37 | + <footer>(optional: e.g. BREAKING CHANGE: details, or issue references)</footer> |
| 38 | +</commit-message> |
| 39 | +``` |
| 40 | + |
| 41 | +### Examples |
| 42 | + |
| 43 | +```xml |
| 44 | +<examples> |
| 45 | + <example>feat(parser): add ability to parse arrays</example> |
| 46 | + <example>fix(ui): correct button alignment</example> |
| 47 | + <example>docs: update README with usage instructions</example> |
| 48 | + <example>refactor: improve performance of data processing</example> |
| 49 | + <example>chore: update dependencies</example> |
| 50 | + <example>feat!: send email on registration (BREAKING CHANGE: email service required)</example> |
| 51 | +</examples> |
| 52 | +``` |
| 53 | + |
| 54 | +### Validation |
| 55 | + |
| 56 | +```xml |
| 57 | +<validation> |
| 58 | + <type>Must be one of the allowed types. See <reference>https://www.conventionalcommits.org/en/v1.0.0/#specification</reference></type> |
| 59 | + <scope>Optional, but recommended for clarity.</scope> |
| 60 | + <description>Required. Use the imperative mood (e.g., "add", not "added").</description> |
| 61 | + <body>Optional. Use for additional context.</body> |
| 62 | + <footer>Use for breaking changes or issue references.</footer> |
| 63 | +</validation> |
| 64 | +``` |
| 65 | + |
| 66 | +### Final Step |
| 67 | + |
| 68 | +```xml |
| 69 | +<final-step> |
| 70 | + <cmd>git commit -m "type(scope): description"</cmd> |
| 71 | + <note>Replace with your constructed message. Include body and footer if needed.</note> |
| 72 | +</final-step> |
| 73 | +``` |
0 commit comments