Git Workflow Enforcer
Aplica fluxos de trabalho Git consistentes, incluindo mensagens de commit, nomenclatura de branches e processos de PR.
Quando usar
- Ao criar commits ou branches
- Em revisão de código ou criação de PR
- Quando o usuário mencionar "git workflow", "commit message", "branch naming" ou "pull request"
Instruções
1. Detectar convenções existentes
Verifique por:
- Templates em
.github/ou.gitlab/ CONTRIBUTING.md- Padrões existentes em mensagens de commit
- Padrões de nomeação de branches
2. Commits Convencionais
Formato: tipo(escopo): descrição
Tipos:
feat: Nova funcionalidadefix: Correção de bugdocs: Documentaçãostyle: Formatação, ponto e vírgula faltandorefactor: Reestruturação de códigoperf: Melhoria de performancetest: Adição de testeschore: Manutenção, dependências
Exemplos:
feat(auth): add OAuth2 login support
fix(api): handle null response in user endpoint
docs(readme): update installation instructions
refactor(utils): simplify date formatting logic
3. Nomenclatura de branches
Padrões comuns:
feature/user-authentication
bugfix/login-error-handling
hotfix/critical-security-patch
release/v1.2.0
chore/update-dependencies
Validar:
- Minúsculas com hífens
- Prefixado com tipo
- Nome descritivo
- Número da issue se aplicável:
feature/123-add-dark-mode
4. Validação de mensagens de commit
Commit bom:
feat(payments): integrate Stripe payment gateway
- Add Stripe SDK configuration
- Implement payment intent creation
- Add webhook handler for payment events
- Update tests for payment flow
Closes #456
Verifique:
- Linha de assunto ≤50 caracteres
- Corpo quebrado em 72 caracteres
- Linha em branco entre assunto e corpo
- Modo imperativo ("add", não "added")
- Referência a issue/ticket
5. Template de PR
Crie .github/PULL_REQUEST_TEMPLATE.md:
## Descrição
<!-- O que este PR faz? -->
## Tipo de mudança
- [ ] Correção de bug
- [ ] Nova funcionalidade
- [ ] Mudança que quebra compatibilidade
- [ ] Atualização de documentação
## Testes
<!-- Como foi testado? -->
## Checklist
- [ ] Código segue as diretrizes de estilo do projeto
- [ ] Auto-revisão concluída
- [ ] Comentários adicionados para código complexo
- [ ] Documentação atualizada
- [ ] Testes adicionados/atualizados
- [ ] Todos os testes passando
- [ ] Nenhum novo aviso
## Issues relacionadas
Closes #
6. Hooks de commit
Pré-commit:
#!/bin/sh
# .git/hooks/pre-commit
# Executar linter
npm run lint
# Executar testes
npm test
# Verificar dados sensíveis
if git diff --cached | grep -i "password\|api_key\|secret"; then
echo "Erro: Possíveis dados sensíveis detectados"
exit 1
fi
Commit-msg:
#!/bin/sh
# .git/hooks/commit-msg
commit_msg=$(cat "$1")
# Verificar formato de commit convencional
if ! echo "$commit_msg" | grep -qE "^(feat|fix|docs|style|refactor|perf|test|chore)(\(.+\))?: .+"; then
echo "Erro: Mensagem de commit deve seguir o formato de Commits Convencionais"
echo "Exemplo: feat(auth): add login feature"
exit 1
fi
7. Validar commits existentes
Verifique commits recentes quanto à adesão ao padrão:
git log --oneline -20 | grep -v "^[a-f0-9]\{7\} (feat|fix|docs|style|refactor|perf|test|chore)"
8. Gerar changelog
A partir de commits convencionais:
# Usando standard-version
npx standard-version
# Ou manualmente, agrupando por tipo
git log --pretty=format:"%s" | grep "^feat" > features.txt
git log --pretty=format:"%s" | grep "^fix" > fixes.txt
9. Branches protegidos
Configurações do GitHub:
- Exigir revisões de PR
- Exigir verificações de status
- Exigir commits assinados
- Restringir quem pode fazer push
- Exigir histórico linear
10. Melhores práticas
- Commits atômicos: Uma mudança lógica por commit
- Mensagens descritivas: Explique o porquê, não o quê
- Commits frequentes: Pequenos e frequentes em vez de grandes e raros
- Histórico limpo: Squash/rebase antes de mesclar
- Assinar commits: Assinatura GPG para segurança
- Referenciar issues: Vincule ao sistema de rastreamento
Template de commit Git
Crie .gitmessage:
<tipo>(<escopo>): <assunto>
<corpo>
<rodapé>
# Tipo: feat, fix, docs, style, refactor, perf, test, chore
# Escopo: componente ou arquivo afetado
# Assunto: imperativo, minúsculo, sem ponto final, ≤50 caracteres
# Corpo: explique o quê e porquê, não como, quebrado em 72 caracteres
# Rodapé: mudanças que quebram compatibilidade, referências a issues
Defina como template:
git config --global commit.template ~/.gitmessage
Arquivos de suporte
templates/PULL_REQUEST_TEMPLATE.mdtemplates/commit-msg-hook.shtemplates/.gitmessage