Skip to content

Instantly share code, notes, and snippets.

@bernardobrezende
Last active May 2, 2019 13:57
Show Gist options
  • Save bernardobrezende/8a729226378bebacbfd1160913128e5c to your computer and use it in GitHub Desktop.
Save bernardobrezende/8a729226378bebacbfd1160913128e5c to your computer and use it in GitHub Desktop.
Checklist antes de commitar o código ou quando for refatorá-lo

Checklist da felicidade

Lista de itens para levar em consideração antes de enviar um código para o restante dos colegas e/ou abrir pull-request.

  • Peguei café suficiente?
  • Se a equipe trabalha com testes automatizados, eu escrevi todos necessários para cobrir meu código, sem impactar na geração de valor para o cliente final?
  • Caso a equipe não trabalhe com testes automatizados, realizei todos procedimentos para validar que meu código funciona como deveria? (Testar manualmente, revisá-lo, debugá-lo, etc)
  • Removi todas as duplicações de código? (métodos iguais, trechos de código semelhantes)
  • Removi todas coisas inutilizadas (classes, variáveis, métodos, scripts, estilos, htmls, imagens)?

⚠️⚠️⚠️ (cuide bem para garantir que algo não é mais utilizado)

  • Deixei tudo legível, na medida do possível (nomes de variáveis, nomes de métodos, nomes de classes) ?
  • Posteriormente se eu voltar a ler o código, conseguirei entendê-lo?
  • Todos os trechos complexos (regras de cálculos, regras de negócio) estão bem documentados (em comentários ou com testes) ?
  • Todos arquivos que precisam estar no commit, de fato estão? (ex: adicionar uma tag <img src="a.jpg"> no html mas esquecer de versionar a.jpg)

Padrões de refatoração

Extract Method

Extraia toda lógica duplicada ou que pode ser agrupada para um método (geralmente privado, depois pode-se avaliar melhorar a modelagem) e utilize este método.

Fonte: http://refactoring.com/catalog/extractMethod.html

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