Orientações para o Autor

Descreva adequadamente o seu pull request (PR)

• Dê ao PR um título descritivo, para que outros membros possam entender facilmente (em uma frase curta) sobre o que se trata o PR.
• Todo PR deve ter uma descrição adequada que mostre ao revisor o que foi alterado e por quê.

Adicione revisores relevantes

• Adicione um ou mais revisores (dependendo das diretrizes do seu projeto) ao PR. Idealmente, você adicionaria pelo menos alguém que tenha expertise e esteja familiarizado com o projeto ou a linguagem utilizada.
• Adicionar alguém menos familiarizado com o projeto ou a linguagem pode ajudar a verificar se as alterações são compreensíveis, fáceis de ler e aumenta a expertise dentro da equipe.
• Nos projetos code-with da ISE com uma equipe de cliente, é importante incluir revisores de ambas as organizações para transferência de conhecimento - Personalize a Política de Revisores

Esteja aberto para receber feedback

Discuta o design/lógica do código e aborde todos os comentários da seguinte forma:

• Resolva um comentário se a alteração solicitada foi feita.
• Marque o comentário como “não vou corrigir” se você não pretende fazer as alterações solicitadas e forneça um raciocínio claro.
  • Se a alteração solicitada estiver dentro do escopo da tarefa, “farei mais tarde” não é uma razão aceitável!
  • Se a alteração solicitada estiver fora do escopo, crie um novo item de trabalho (tarefa ou bug) para ela.
• Se você não entender um comentário, faça perguntas na própria revisão em vez de iniciar um chat privado.
• Se uma discussão se estender sem uma conclusão, agende uma reunião com o revisor (ligue para eles ou bata à porta).

Use listas de verificação

Ao criar um PR, é uma boa ideia adicionar uma lista de verificação dos objetivos do PR na descrição. Isso ajuda os revisores a se concentrarem nas áreas-chave das alterações de código.

Vincule uma tarefa ao seu PR

Vincule os itens de trabalho/tarefas correspondentes ao PR. Não é necessário duplicar informações entre o item de trabalho e o PR, mas se alguns detalhes estiverem faltando em um deles, juntos eles fornecem mais contexto ao revisor.

O código deve ter anotações antes da revisão

Se você não puder evitar PRs grandes, inclua explicações das alterações para facilitar a revisão do código. Com comentários claros, o revisor pode identificar o objetivo de cada bloco de código.