git-workflow
Follow git conventions for commits, branches, and PRs. Auto-activated during git operations.
When & Why to Use This Skill
The Git Workflow skill is designed to automate and enforce professional version control standards across the entire development lifecycle. By implementing strict conventions for commit messages, branch naming, and Pull Request (PR) templates, it ensures a clean, readable, and searchable project history. This skill acts as an automated guardian for repository health, helping teams maintain high code quality and streamline collaboration through standardized Git practices.
Use Cases
- Standardizing Commit Messages: Automatically formatting commits using the Conventional Commits specification (feat, fix, refactor) to enable automated changelog generation and better traceability.
- Enforcing Branch Naming Conventions: Ensuring all new branches follow a structured format (e.g., type/ticket-id-description) to improve organization and integration with project management tools.
- Streamlining Pull Request Workflows: Utilizing standardized PR templates and quality checklists to ensure every submission includes necessary context, passing tests, and documentation updates.
- Automating Quality Checks: Implementing a pre-commit checklist to verify that code builds, tests pass, and no sensitive data is included before changes are pushed to the remote repository.
| name | git-workflow |
|---|---|
| description | Follow git conventions for commits, branches, and PRs. |
Git Workflow Skill
Purpose
Ensure consistent git practices across all phases.
Commit Message Convention
Reference: conventions/commit-messages.md
Format
<type>(<scope>): <subject>
[optional body]
[optional footer]
Types
| Type | Use For |
|---|---|
| feat | New feature |
| fix | Bug fix |
| refactor | Code restructuring |
| docs | Documentation |
| test | Test changes |
| chore | Maintenance |
| perf | Performance improvement |
| style | Formatting, no code change |
| ci | CI/CD changes |
Examples
feat(auth): implement JWT token refresh
- Add refresh token endpoint
- Update token validation logic
- Add integration tests
Closes #123
Branch Naming
Reference: conventions/branch-naming.md
Format: <type>/<ticket>-<description>
Examples:
feat/AUTH-123-jwt-refreshfix/BUG-456-login-errorrefactor/TECH-789-user-service
PR Template
Reference: conventions/pr-template.md
Workflow Best Practices
Commit Frequency
- Commit after each logical unit of work
- Each commit should be independently buildable
- Don't commit broken code
Branch Strategy
- Create feature branch from main/develop
- Keep branches short-lived
- Rebase before merge when appropriate
PR Guidelines
- Keep PRs focused and reviewable
- Include context in description
- Link to related issues
- Request appropriate reviewers
Quality Checklist
Before committing:
- Code compiles/builds
- Tests pass
- Lint passes
- Commit message follows convention
- No sensitive data included
Before creating PR:
- Branch is up to date
- All commits are meaningful
- PR description is complete
- Tests are included
- Documentation updated