Merge branch 'main' into docs/zh-trans-basic-features-251113
This commit is contained in:
@@ -9,6 +9,7 @@ This feature only analyzes **staged changes**. Make sure to stage your files usi
|
||||
## How It Works
|
||||
|
||||
The git commit message generator:
|
||||
|
||||
- Analyzes only your **staged changes** (not unstaged or untracked files)
|
||||
- Uses AI to understand the context and purpose of your changes
|
||||
- Creates descriptive commit messages that explain what was changed and why following the [Conventional Commits](https://www.conventionalcommits.org/) (by default, customizable)
|
||||
@@ -21,7 +22,6 @@ The git commit message generator:
|
||||
2. In the VS Code Source Control panel, look for the `Kilo Code` logo next to the commit message field
|
||||
3. Click the logo to generate a commit message
|
||||
|
||||
|
||||
The generated message will appear in the commit message field, ready for you to review and modify if needed.
|
||||
|
||||
<img src="/docs/img/git-commit-generation/git-commit-1.png" alt="Generated commit message example" width="600" />
|
||||
@@ -37,6 +37,7 @@ By default, generated messages follow the Conventional Commits specification:
|
||||
```
|
||||
|
||||
Common types include:
|
||||
|
||||
- `feat`: New features
|
||||
- `fix`: Bug fixes
|
||||
- `docs`: Documentation changes
|
||||
@@ -58,6 +59,7 @@ You can customize how commit messages are generated by modifying the prompt temp
|
||||
<img src="/docs/img/git-commit-generation/git-commit-2.png" alt="Commit message generation settings" width="600" />
|
||||
|
||||
The default template creates conventional commit messages, but you can modify it to:
|
||||
|
||||
- Use different commit message formats
|
||||
- Include specific information relevant to your project
|
||||
- Follow your team's commit message conventions
|
||||
@@ -77,16 +79,19 @@ Consider creating a dedicated [API configuration profile](/features/api-configur
|
||||
## Best Practices
|
||||
|
||||
### Staging Strategy
|
||||
|
||||
- Stage related changes together for more coherent commit messages
|
||||
- Avoid staging unrelated changes in a single commit
|
||||
- Use `git add -p` for partial file staging when needed
|
||||
|
||||
### Message Review
|
||||
|
||||
- Always review generated messages before committing
|
||||
- Edit messages to add context the AI might have missed
|
||||
- Ensure the message accurately describes the changes
|
||||
|
||||
### Custom Templates
|
||||
|
||||
- Tailor the prompt template to your project's needs
|
||||
- Include project-specific terminology or conventions
|
||||
- Add instructions for handling specific types of changes
|
||||
@@ -121,7 +126,9 @@ setup steps for new contributors
|
||||
## Troubleshooting
|
||||
|
||||
### No Staged Changes
|
||||
|
||||
If the button doesn't appear or generation fails, ensure you have staged changes:
|
||||
|
||||
```bash
|
||||
git add <files>
|
||||
# or stage all changes
|
||||
@@ -129,13 +136,17 @@ git add .
|
||||
```
|
||||
|
||||
### Poor Message Quality
|
||||
|
||||
If generated messages aren't helpful:
|
||||
|
||||
- Review your staging strategy - don't stage unrelated changes together
|
||||
- Customize the prompt template with more specific instructions
|
||||
- Try a different AI model through API configuration
|
||||
|
||||
### Integration Issues
|
||||
|
||||
The feature integrates with VS Code's built-in git functionality. If you encounter issues:
|
||||
|
||||
- Ensure your repository is properly initialized
|
||||
- Check that VS Code can access your git repository
|
||||
- Verify git is installed and accessible from VS Code
|
||||
@@ -143,4 +154,4 @@ The feature integrates with VS Code's built-in git functionality. If you encount
|
||||
## Related Features
|
||||
|
||||
- [API Configuration Profiles](/features/api-configuration-profiles) - Use different models for commit generation
|
||||
- [Settings Management](/features/settings-management) - Manage all your Kilo Code preferences
|
||||
- [Settings Management](/features/settings-management) - Manage all your Kilo Code preferences
|
||||
|
||||
Reference in New Issue
Block a user