Receber uma revisão de pedido de puxar¶

O seu pull pedido foi submetido, e passou o CI. Agora está pronto para ser revisto.

tl;dr - O processo de revisão¶

A versão resumida do processo de revisão:

Aguardar uma revisão.
Responder ao retorno de informação (feedback).
Se forem solicitadas alterações:
- Trabalhar para concluir as alterações solicitadas.
- Submeter todas as alterações solicitadas.
- Solicitar novamente uma revisão quando todas as alterações solicitadas tiverem sido submetidas.
- Repetir a secção três até que não sejam necessárias mais alterações.
Aguardar que o seu pedido de puxar seja aprovado e fundido.

Parabéns! Acabou de fazer uma contribuição para BeeWare!

Submeti o meu pedido de puxar, o que vem a seguir?¶

Depois de enviar o seu pedido de puxar, vai precisar aguardar a revisão da sua contribuição. Há dois lados no processo de revisão: fornecer uma revisão e receber uma revisão.

Rever as expectativas

Deve esperar que todas as pessoas que revejam os seus envios sigam essas diretrizes, inclusive as revisões dos membros da equipa principal. Também deve seguir essas diretrizes quando estiver a rever os envios de outras pessoas.

Se achar que o seu revisor está a desviar-se destas expectativas e se sentir à vontade para levantar o problema no pedido de puxar, pode fazer isso. Se não se sentir confortável, entre em contacto com a Equipa de Resposta ao Código de Conduta do BeeWare. Iremos analisar o seu relatório e faremos o acompanhamento com o seu revisor. O acompanhamento irá refletir a ação relatada; uma transgressão menor pode resultar numa discussão, enquanto uma violação maior pode resultar em algo mais sério.

Fornecer uma revisão¶

Todos são bem vindos para fazer uma revisão em qualquer pedido de puxar. Estas diretrizes descrevem as nossas expectativas em relação a uma revisão, independentemente dela ser fornecida por um membro da equipa principal ou por um membro da comunidade.

Um membro da equipa principal vai sempre precisar de fazer a revisão final, mas as revisões dos membros da comunidade podem ser uma maneira útil de agilizar o processo - idealmente, a revisão da equipa principal seria uma formalidade após as revisões da comunidade terem identificado todos os principais problemas.

Receber uma revisão¶

O receber duma revisão envolve três passos básicos:

Resposta de retorno e perguntas iniciais.
Solicitações de alteração.
Aprovação e fusão.

Cada passo está detalhado em baixo. Se em algum momento do processo tiver dúvidas, não hesite em perguntar! Ficamos felizes em ajudar.

Cronologia e feedback inicial¶

A equipa principal tem como objetivo garantir que todos os pedidos de puxar recebam uma revisão dentro de dez dias úteis. No entanto, com envios mais complicados, ou quando um pedido de puxar é submetido e parte da equipa está de férias, esse prazo pode ser estendido.

Normalmente, mantemos a continuidade com os revisores em cada pedido de puxar, ou seja, provavelmente vai trabalhar com o mesmo revisor durante toda a revisão. Isso significa que o revisor terá contexto durante todo o processo e você vai poder saber o que esperar em termos de cadência de resposta e estilo de revisão. Se o revisor inicial identificar que não tem conhecimento necessário para rever os sues pedidos, ou se souber que não vai estar disponível por algum motivo, ele poderá passar a responsabilidade pelo seu pedido de puxar para outro membro da equipa.

Pode esperar uma resposta nossa a cada troca dentro de um prazo contínuo de dez dias úteis. Responder a comentários e perguntas é uma parte essencial do processo de revisão. Esperamos uma resposta sua antes de passarmos para o próximo passo do processo.

Solicitações de alteração¶

Na maioria das vezes, o revisor vai solicitar alterações no seu pedido de puxar. Isto não é necessariamente um reflexo do seu trabalho, é simplesmente parte do processo.

Se a revisão inicial revelar um número significante de problemas, a primeira revisão poderá não ser abrangente. Em vez disso, ela vai-se concentrar em fornecer orientação de alto nível sobre o trabalho necessário para colocar o pedido num estado de poder ser fundido. O processo de revisão pode incluir perguntas para esclarecer a finalidade e o escopo do trabalho que foi tentado.

Trabalhar com as alterações solicitadas¶

O seu revisor vai publicar comentários no seu pedido de puxar. Esses comentários podem ser gerais, num ficheiro específico ou numa linha ou linhas específicas de código. Às vezes, eles vão incluir alterações sugeridas diretamente que pode aplicar ao seu pedido de puxar por meio da interface de utilizador do GitHub. Normalmente, eles são perguntas, solicitações de esclarecimento ou orientações sobre atualizações.

Marcar uma conversa como resolvida

Durante a parte de discussão do processo de feedback, nunca deve marcar uma conversa iniciada pelo seu revisor como "resolvida". Marcar a conversa como resolvida é responsabilidade do revisor. Cabe a ele determinar se o problema identificado foi resolvido.

Se a revisão revelar um problema sistemático (por exemplo, uma inconsistência de nomenclatura existente no código), o revisor pode não destacar todas as instâncias desse problema. Em vez disso, ele pode escolher alguns exemplos do problema e indicar que outras instâncias também devem ser corrigidas. Se uma revisão destacar um problema num local e você achar que ele pode se aplicar a outro, corrija esse problema onde quer que ele ocorra. Se não tiver certeza, peça esclarecimentos ao revisor.

Submeter todas as alterações solicitadas¶

Depois de fazer todas as alterações solicitadas, pode enviar uma atualização para o seu pedido de puxar. Isto vai acionar uma nova execução de CI; depois de confirmar que a CI ainda está a passar, publique um comentário a solicitar uma revisão atualizada e a equipa principal irá analisar novamente o seu pedido de puxar.

Empurre, não force nem faça rebase

Quando estiver a atualizar o seu pedido e puxar durante uma revisão, é importante deixar o histórico de submissões intacto. Não importa se há uma lista enorme de submissões; todos eles são esmagados quando fazemos a fusão do pedido de puxar. Se forçar o push ou rebase do seu pedido de puxar a meio de uma revisão, poderá estar a remover um contexto importante necessário para o revisor.

Solicitar novamente uma revisão¶

Depois de resolver todas as alterações solicitadas numa determinada revisão e o CI for aprovado novamente, pode solicitar novamente uma revisão ao seu revisor. Se um problema for particularmente complicado e a correção de uma coisa afetar outra, pode solicitar uma revisão da parte específica que atualizou. O pressuposto é que qualquer solicitação de revisão é uma solicitação de revisão completa. Se não estiver pronto para uma revisão completa, certifique-se de especificar exatamente o que está a procurar.

Aprovação e fusão do pedido de puxar¶

Depois que responder a todas as solicitações de alteração, o pedido de puxar vai ser aprovado. Na maioria dos casos, quando um pedido de puxar é aprovado, nós o fundimos imediatamente. Em alguns casos, pode haver circunstâncias atenuantes, como depender de outro pedido de puxar ainda não fundido, que leva a um atraso. Iremos comunicar isso nos comentários, para que saiba da situação.