Generate Conventional Commit Messages
Generate conventional commit messages from code changes. Ensures standardized commit history for better project management and collaboration.
Why it matters
Automate the creation of standardized commit messages for code changes. This ensures consistency and clarity in your version control history, making collaboration and code reviews more efficient.
Outcomes
What it gets done
Analyze code diffs to understand changes.
Generate commit messages adhering to conventional commits format.
Ensure subject lines are concise and imperative.
Incorporate optional body and footer for detailed context and issue tracking.
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/vb-commit-message | bash Use cases
What you can do with it
Writes source code or scripts from a description.
Analyzes code for bugs, style issues, and improvements.
Drafts marketing, email, or product copy on demand.
Overview
Commit Message Generator
What it does
This AI prompt generates commit messages adhering to the Conventional Commits specification. It analyzes code changes to produce messages with a type (e.g., feat, fix, docs), an optional scope, a concise description, and optional body/footer for details. This ensures a standardized and machine-readable commit history.
How it connects
Utilize this prompt when committing code changes to maintain a consistent and organized project history. It is particularly beneficial for projects following or aiming to adopt the Conventional Commits standard for improved collaboration and automated changelog generation.
Source README
Generate a commit message for the following changes.
Format
Use conventional commits format:
<type>(<scope>): <description>
[optional body]
[optional footer]
Types
feat: New featurefix: Bug fixdocs: Documentation changesstyle: Formatting, missing semicolons, etc.refactor: Code restructuring without behavior changeperf: Performance improvementstest: Adding or updating testschore: Maintenance tasks, dependencies
Guidelines
- Subject line: 50 characters max, imperative mood
- Body: Explain what and why, not how
- Footer: Reference issues, breaking changes
Examples
feat(auth): add OAuth2 login with Google
Implement Google OAuth2 authentication flow.
Users can now sign in using their Google accounts.
Closes #123
fix(api): handle null response from external service
The external API occasionally returns null instead of
an empty array. Added null check to prevent crashes.
Fixes #456
refactor(database): extract query builder into service
Move complex query construction logic from controllers
to a dedicated QueryBuilder service for better testability.
Now analyze the diff and generate an appropriate commit message.
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.