Skip to content

Instantly share code, notes, and snippets.

@luiznegreiros
Last active April 28, 2023 13:30
Show Gist options
  • Save luiznegreiros/d1c315de2234e9ff30569d7a893ccdc6 to your computer and use it in GitHub Desktop.
Save luiznegreiros/d1c315de2234e9ff30569d7a893ccdc6 to your computer and use it in GitHub Desktop.
[CODE REVIEW] MANIFESTO

[CODE REVIEW] MANIFESTO

Porque fazemos Code Review?

Para avaliar melhorias, qualidade ou erros no código; Garantir padrões básicos de desenvolvimento; (Listar padrões) Resgatar a união entre Devs (Comunidade); Compartilhar conhecimento; Pensar em alta performance como padrão no code base;

Como fazemos Code Review?

Pair Programming; Por funcionalidade no gitlab (Aproves); Time/Squad efetua code Review interno antes do COR/CAB; Com comentários de melhorias sobre o código (Seja gentil e explicativo); Através de Threads SEMPRE;

O que buscamos encontrar no Code Review?

Design :

O código é bem projetado e apropriado para o seu sistema?

Funcionalidade :

O código se comporta como o autor provavelmente pretendia? A maneira como o código se comporta é boa para seus usuários?

Complexidade :

O código poderia ser simplificado? Outro desenvolvedor seria capaz de entender e usar facilmente esse código quando se deparar com ele no futuro?

Testes :

O código possui testes automatizados corretos e bem desenhados?

Nomeação :

O desenvolvedor escolheu nomes claros para variáveis, classes, métodos, etc.?

Comentários :

Os comentários são claros e úteis?

Estilo :

O código segue nossos guias de estilo ?

Documentação :

O desenvolvedor também atualizou a documentação relevante?

Merge Request Template

[ ] O nome da branch segue o padrão definido? ex: feature/MMM-100, bug-fix/MMM-123 ou hotfix/xxx
[ ] O titulo da MR segue padrão? ex: MMM-100 - Adicionar Template de pull requests
[ ] MR com a descrição do objetivo da entrega?
[ ] Foi informado o link da task no JIRA?
[ ] A opção Assign na MR foi preenchida com o nome do responsável da task?
[ ] Foram feitos os Testes Unitários?
[ ] A execução do pipeline de CI apresentou sucesso nos testes unitários.
[ ] Validar se não há sugestões no SonarQube (My Issues, duplicate code, coverage).
[ ] Avaliar se a cobertura de teste está acima da métrica estipulada no sonar.
[ ] Feature flags estão com valores default.
[ ] ESlint disable apenas se extremamente necessário e com justificativa.
[ ] Código está seguindo os padrões e boas práticas:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment