Commit Helper

What it does

The peopleforrester-commit-helper skill assists with creating Git commit messages. It can generate a draft commit message based on provided changes or refine an existing one to adhere to specific conventions. This helps ensure clear and consistent commit history for projects.

When to use it

• Generating initial commit messages: When you've made several changes but aren’t sure how to best summarize them in a commit message.
• Refining existing drafts: If you have a draft commit message that needs polishing or better alignment with project conventions.
• Enforcing commit style guidelines: To ensure all commits adhere to a defined format (e.g., conventional commits).
• Quickly creating concise messages: When needing to create short, descriptive commit messages for minor changes.

Key capabilities

• Generates draft commit messages from change descriptions.
• Refines existing commit message drafts.
• Supports project-specific commit conventions (details not specified).

Example prompts

• "Generate a commit message for these changes: Refactor user authentication module."
• "Improve this commit message: 'Fixed bug'."
• "Create a conventional commit based on the following changes: Add new feature X, breaking change to API endpoint Y."

Tips & gotchas

The skill's effectiveness depends on providing clear and concise descriptions of the changes being committed. While it can refine existing messages, understanding basic Git conventions will improve results.