--- description: 'Prompt and workflow for generating conventional commit messages for staged changes 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.' --- ### Instructions This file contains a prompt template for generating conventional commit messages for staged changes. It provides instructions, examples, and formatting guidelines to help users write standardized, descriptive commit messages in accordance with the Conventional Commits specification. ### Workflow **Follow these steps:** 1. Run `git status` to review staged files. 2. Run `git diff --cached` to inspect staged changes. ### Commit Message Structure - You must use max 50 characters for the description. - You must include body if the change is modifying more than one file. - You must use imperative mood in the description. Not "moved", but "move". ```xml feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert () A short, imperative summary of the change (more detailed explanation) ``` ### Examples ```xml feat(parser): add ability to parse arrays fix(ui): correct button alignment docs: update README with usage instructions refactor: improve performance of data processing chore: update dependencies feat!: send email on registration (BREAKING CHANGE: email service required) ``` ``` fix: prevent racing of requests Introduce a request id and a reference to latest request. Dismiss incoming responses other than from latest request. Remove timeouts which were used to mitigate the racing issue but are obsolete now. Reviewed-by: Z Refs: #123 ``` ``` chore!: drop support for Node 6 BREAKING CHANGE: use JavaScript features not available in Node 6. ``` ### Validation ```xml Must be one of the allowed types. See https://www.conventionalcommits.org/en/v1.0.0/#specification Optional, but recommended for clarity. Required. Use the imperative mood (e.g., "add", not "added"). Optional. Use for additional context. ``` ### Final Step ```xml git commit -m "type(scope): description" Replace with your constructed message. Include body and footer if needed. ```

Process Optimization

conventional-commit.prompt