Fornecer uma revisão de pedido de puxar

Sempre ficamos felizes em receber avaliações de colaboradores, independentemente do seu nível de experiência.

Porque rever as contribuições?

Todas as contribuições enviadas precisam ser revistas, independentemente de terem sido enviadas por um membro da equipa principal ou por um colaborador de primeira vez. Todos têm a possibilidade de deixar passar alguma coisa. O processo de revisão foi criado para oferecer uma rede de segurança adicional.

O objetivo do processo de revisão é garantir que todo o conteúdo, incluindo código e documentação, esteja o mais livre de erros e seja o mais fácil de manter possível. Qualquer coisa que possa fazer para promover esse objetivo é uma contribuição bem-vinda. Isto pode variar de algo tão simples como corrigir um erro ortográfico até identificar casos extremos no uso da API que não estão a ser detetados. Pode identificar maneiras de tornar o regime de testes mais robusto ou sugerir formas de estruturar a arquitetura geral das alterações para que sejam mais fáceis de manter ou expandir.

Posso rever?

Sim! Pode oferecer uma revisão em qualquer pedido de puxar que veja aberto em BeeWare.

Como colaborador de primeira vez, sinta-se à vontade para analisar qualquer pedido de puxar que encontrar, mesmo que tenha sido enviado por um membro da equipa principal. Se for um novato, talvez esteja a perder algum contexto maior do projeto, mas o nosso objetivo é manter a base de código acessível independentemente do seu nível de experiência. Se houver algo no código que não faça sentido, isso pode indicar que há necessidade de mais documentação (seja no código ou como documentação de desenho autónomo).

Contribuir com uma revisão de pedido de puxar

Fornecer uma revisão de pedido de puxar

Fornecer uma revisão de pedido de puxar

Todos são bem-vindos para rever qualquer contribuição para o projeto BeeWare. Há algumas considerações importantes que devem ser tidas em conta antes de começar.

PENSAR antes de rever

Antes de se envolver numa avaliação, PENSE. Como revisores, devemos considerar se a resposta que estamos prestes a enviar é:

• Verdadeira. Esforce-se sempre para fornecer sugestões e informações precisas.
• Útil. Estamos a fornecer orientação sobre como melhorar a submissão; essa orientação deve identificar claramente a origem de um problema ou de um caso de uso não considerado e, idealmente, fornecer um caminho a seguir para resolver ou satisfazer a preocupação.
• Inspiradora. Cabe a nós inspirar o autor a querer trabalhar com as nossas alterações solicitadas.
• Necessária. A expectativa é que o autor leia tudo o que postamos; devemos respeitar seu tempo e esforço postando só quando necessário.
• Gentil. Há várias maneiras de apresentar o mesmo retorno de informação; precisamos garantir que estamos a escolher ser gentis, solidários e construtivos com as nossas palavras.

É perfeitamente possível PENSAR e, ao mesmo tempo, fazer uma revisão eficaz. Os conceitos discutidos acima não impedem que aponte quaisquer problemas que encontrar num PR. Os colaboradores não terão a oportunidade de melhorar a sua contribuição se não tiverem conhecimento das áreas que precisam ser melhoradas. O importante é estar ciente de como está a apresentar esse retorno de informação. Tente despersonalizar a sua avaliação. Em vez de dizer: "Você cometeu um erro", pode dizer: "Este código pode ser melhorado". Analise o código, não o autor.

É importante lembrar-se de fornecer retorno de informação positivo, além de identificar as áreas que precisam ser melhoradas. Se, por exemplo, as alterações forem especialmente úteis, fizerem algo particularmente inteligente ou for apresentado a uma API que não conhecia, informe o autor! Nunca subestime o efeito de apontar algo que alguém fez corretamente ou bem, no meio de uma situação em que tudo o mais que apontou são problemas que precisam ser resolvidos.

Sugestões de revisão do GitHub

A interface de revisão do GitHub tem um mecanismo para sugestões de alteração, no qual pode fornecer a alteração exata que está a sugerir como uma substituição do conteúdo existente. Lembre-se de que, até que sejam aceites e confirmadas, essas alterações sugeridas não passarão pelas verificações de pré-compromisso e de análise de código. Portanto, esta funcionalidade deve ser usada para alterações menores, pois quanto maior for a alteração sugerida, maior será a probabilidade dela introduzir problemas.