Git Integration Practices with GitHub Copilot
Commit Message Generation
1. Conventional Commits
Write a commit message following conventional commits format for these changes:
[paste diff or describe changes]
Expected format:
type(scope): description
#Examples:
feat(auth): add OAuth2 authentication
fix(api): handle null response from endpoint
docs(readme): update installation instructions
Generate PR review comments for:
- Potential issues
- Style violations
- Performance concerns
- Security risks
Branch Management
1. Branch Naming
Generate branch name for:
- Feature implementation
- Bug fix
- Documentation update
- Performance improvement
Format: type/description-in-kebab-case
2. PR Descriptions
Write PR description including:
- Changes overview
- Breaking changes
- Dependencies
- Testing instructions
Git Workflows
1. Feature Development
1. Branch Creation
```
git checkout -b feat/new-feature
```
2. Regular Commits
- Small, focused changes
- Clear commit messages
- Link to issues
3. PR Creation
- Comprehensive description
- Review checklist
- Testing evidence
2. Code Review Process
1. Self-Review
- Run automated checks
- Update documentation
- Add test coverage
2. Peer Review
- Address comments
- Update changes
- Request re-review
3. Merge Preparation
- Resolve conflicts
- Squash commits
- Update changelog
Best Practices
1. Commit Organization
- Group related changes
- Separate refactoring
- Isolate formatting changes
- Split large changes
2. Branch Strategy
- Short-lived feature branches
- Regular rebasing
- Clean merge history
- Protected main branch
3. Review Workflow
- Early feedback
- Incremental reviews
- Clear communications
- Tracked changes
Copilot-Specific Tips
1. Generated Code Management
1. Review generated code before commit
2. Break large generations into smaller commits
3. Document generation context
4. Track manual modifications
2. Documentation Updates
1. Update docs with generated changes
2. Include generation prompts
3. Document review decisions
4. Maintain changelog
3. Version Control Integration
1. Use .gitignore for Copilot files
2. Track manual overrides
3. Document configuration
4. Manage settings
Team Guidelines
1. Standard Practices
- Consistent commit messages
- Branch naming conventions
- PR templates
- Review checklists
2. Communication
- Clear PR descriptions
- Detailed review comments
- Context sharing
- Decision tracking
3. Quality Assurance
- Automated checks
- Manual review
- Testing requirements
- Documentation updates