Revisões de código e aprovações

As revisões de código são um dos pilares do desenvolvimento moderno de software. Elas consistem em um exame sistemático do código-fonte por colegas para encontrar e corrigir erros não identificados na fase inicial de desenvolvimento.

Os principais objetivos incluem:

• Melhorar a qualidade do código: Detectar bugs, vulnerabilidades de segurança e falhas de projeto antecipadamente.
• Compartilhar conhecimento: Disseminar pela equipe o entendimento da base de código.
• Orientar: Desenvolvedores experientes podem orientar os iniciantes, e todos aprendem com diferentes perspectivas.

No GitHub, o processo de revisão de código normalmente segue estas etapas:

1. Um autor cria uma solicitação de pull (PR) com suas alterações.
2. O autor atribui ou solicita revisores.
3. Os revisores examinam o código, deixando comentários e sugestões.
4. O autor responde ao feedback, enviando novos commits para a ramificação da PR.
5. Quando estão satisfeitos, os revisores aprovam as alterações.
6. Por fim, a PR é mesclada à ramificação principal.

Uma boa revisão de código não consiste apenas em encontrar bugs; trata-se de melhorar a saúde geral do projeto. Ao revisar, considere:

• Correção: O código faz o que deveria? Há casos extremos?
• Legibilidade: É fácil de entender? Os nomes das variáveis são claros?
• Manutenibilidade: Outras pessoas poderão modificar ou estender esse código facilmente mais tarde?
• Desempenho: Há ineficiências óbvias?
• Segurança: O código introduz alguma vulnerabilidade?

Como revisor, seu feedback deve ser sempre construtivo e respeitoso. Lembre-se de que você está revisando o código, não a pessoa que o escreveu.

Dicas para fornecer feedback:

• Seja específico: Aponte linhas exatas do código.
• Explique o "porquê": Não diga apenas "altere isto"; explique *por que* isso deve ser alterado.
• Sugira soluções: Ofereça abordagens alternativas ou trechos de código.
• Seja cordial: Use uma linguagem educada e presuma boas intenções.

O GitHub oferece ferramentas avançadas para agilizar o processo de revisão:

• Comentários em linhas: Clique em uma linha na aba "Files changed" para adicionar um comentário diretamente.
• Sugestões: Você pode propor alterações específicas no código que o autor poderá aplicar com um único clique.
• Revisão resumida: No final, você pode enviar uma revisão resumida com o status "Comment", "Approve" ou "Request changes".

As sugestões são especialmente úteis para melhorias pequenas e claras:

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Se você for o autor de uma solicitação de pull, responder ao feedback é fundamental. Isso mostra que você está envolvido e comprometido em melhorar o código.

Ao responder aos comentários:

• Reconheça: Responda a cada comentário, mesmo que seja apenas para dizer "Boa observação!" ou "Concluído".
• Faça alterações: Envie novos commits para a ramificação da sua PR. O GitHub atualizará a PR automaticamente.
• Resolva as conversas: Quando um comentário for resolvido, marque-o como "Resolved" no GitHub.
• Faça perguntas: Se não entender uma sugestão, peça esclarecimentos.

O status "Approve" é um sinal claro de que o revisor está satisfeito com as alterações de uma solicitação de pull. Muitos repositórios são configurados para exigir pelo menos uma aprovação (ou mais) antes que uma PR possa ser mesclada.

Uma aprovação indica que o revisor acredita que o código:

• Atende aos requisitos.
• Foi bem escrito e pode ser mantido.
• Resolveu todas as preocupações significativas.

É o sinal verde para a integração!

Às vezes, uma solicitação de pull precisa de mais trabalho antes de poder ser mesclada. Nesses casos, um revisor pode escolher "Request changes" como status da revisão.

Esse status comunica claramente que:

• Há problemas bloqueadores que precisam ser resolvidos.
• A PR não pode ser mesclada até que essas alterações sejam feitas e o revisor conceda uma nova aprovação.

Use essa opção quando os problemas forem significativos e impedirem que o código seja considerado aceitável.

Para aproveitar ao máximo as revisões de código, autores e revisores devem seguir algumas boas práticas:

• Mantenha as PRs pequenas: PRs menores são mais fáceis e rápidas de revisar.
• Forneça descrições claras: Os autores devem fornecer descrições detalhadas da PR e o contexto.
• Seja ágil: Os revisores devem tentar revisar rapidamente; os autores devem responder prontamente.
• Automatize o que puder: Use ferramentas de análise estática e testes automatizados para detectar problemas simples antes da revisão.
• Aprenda com as revisões: Considere cada revisão uma oportunidade de aprender e melhorar.

Com base no que aprendemos, quais das opções a seguir são consideradas boas práticas para participar de revisões de código?

Você explorou o universo das revisões de código e dos recursos de aprovação do GitHub! Abordamos por que as revisões são essenciais para a qualidade do código e o compartilhamento de conhecimento, o fluxo típico de revisão e os principais elementos de boas práticas de revisão.

Lembre-se de sempre fornecer feedback construtivo, utilizar as ferramentas do GitHub, como as sugestões, e seguir boas práticas tanto ao revisar quanto ao responder ao feedback. As aprovações e a opção "Request changes" são sinais fundamentais para gerenciar suas PRs com eficácia.

Continue praticando essas habilidades para se tornar um colaborador valioso!