Commit messages
Bob can automatically generate meaningful commit messages based on your staged changes, saving you time and ensuring consistency in your commit history.
Why use this feature?
- Save time: Generate well-formatted commit messages with a single click
- Maintain consistency: Follow conventional commit standards automatically
- Match project style: Bob analyzes your branch name and commit history to match your project's conventions
- Iterate easily: Generate alternative suggestions if you do not like the first one
How it works
Bob examines your staged changes to understand what modifications you have made to your codebase. It then analyzes your branch name and recent commit history to determine the appropriate commit message format that matches your project's style.
Getting started
Prerequisites
Your changes must be staged in the Source Control panel.
Basic usage
To automatically generate a commit message:
- Click the sparkle () icon next to the commit message box.
- Review your commit message made by Bob.
- Click the sparkle () icon again for alternative suggestions. Apply edits to your message, if needed.
- Commit your changes.
Tips and best practices
- For the best results, make atomic commits (changes that address a single concern).
- If you are working on a specific issue, include the issue number in your branch name.
- Edit the generated message if needed to add more specific details.
- Use the regenerate option if the first suggestion does not capture your changes accurately.
How is this topic?