Fornecer uma revisão de solicitação pull

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

PENSAR antes de revisar

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

• Verdadeiro. Sempre se esforce para fornecer sugestões e informações precisas.
• Útil. Estamos fornecendo orientação sobre como melhorar o envio; 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.
• Inspirador. Cabe a nós inspirar o autor a querer trabalhar com nossas alterações solicitadas.
• Necessário. A expectativa é que o autor leia tudo o que postamos; devemos respeitar seu tempo e esforço postando somente quando necessário.
• Gentil. Há várias maneiras de apresentar o mesmo feedback; precisamos garantir que estamos escolhendo ser gentis, solidários e construtivos com nossas palavras.

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

É importante lembrar-se de fornecer feedback positivo, além de identificar as áreas que precisam ser aprimoradas. Se, por exemplo, as alterações forem especialmente úteis, fizerem algo particularmente inteligente ou você 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 você 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 você pode fornecer a alteração exata que está sugerindo como uma substituição do conteúdo existente. Lembre-se de que, até que sejam aceitas e confirmadas, essas alterações sugeridas não passarão pelas verificações de pré-compromisso e de linting. Portanto, esse recurso deve ser usado para alterações menores, pois quanto maior for a alteração sugerida, maior será a probabilidade de ela introduzir problemas.