Pull requests

Como fazer um ótimo pull request

Pull requests (PRs) são a forma de você enviar suas mudanças propostas para alguma parte da base de código do Exercism. Se você está lendo isto e montando um PR, obrigado! Este guia tem como objetivo ajudar você com o lado não técnico dos PRs, para que você tenha uma ótima experiência e, ao mesmo tempo, ajude nossa equipe de mantenedores.

O que esperar

O processo para os PRs é o seguinte:

  • Você envia um PR
  • Um ou mais mantenedores revisam o PR, deixando comentários com sugestões. Em alguns casos, eles podem discutir o PR por completo, para avaliar se aquilo é realmente algo que deve ser adicionado.
  • Seu PR é mesclado e você ganha Reputação no site. Ou seu PR é fechado.

Como faço para mesclar meu PR?

Existem algumas coisas que você pode fazer desde o início para aumentar as chances de seu PR ser mesclado com o mínimo de alterações.

O mais importante é garantir, antes de enviar o PR, que os mantenedores vão receber bem as mudanças que você está fazendo. A forma mais fácil de fazer isso é abrir uma Issue no GitHub primeiro, explicando o que você pretende fazer e perguntando se os mantenedores estão abertos a essas mudanças.

Note

Se você encontrar uma Task no site do Exercism, não precisa abrir uma nova Issue. Você pode comentar na Issue existente dizendo que vai trabalhar nela e depois seguir em frente.

A segunda coisa é garantir que você deixe uma descrição clara no PR ao abri-lo. PRs sem descrição são incrivelmente frustrantes para os mantenedores, que não têm contexto nenhum ao ler o código. Conte por que você fez as mudanças, coloque o link da Issue à qual o PR se refere, explique os trade-offs que você precisou fazer, etc.

Por fim, garanta que seu PR contenha apenas mudanças relacionadas a uma melhoria. Se você tem várias melhorias, divida-as em vários PRs. Isso torna a revisão mais fácil e rápida para os mantenedores, e vai facilitar a sua vida também.

Quanto tempo devo esperar?

Normalmente os mantenedores revisam seu PR em alguns dias. Por favor, não fique insistindo no PR com comentários extras durante a primeira semana: nossos mantenedores são voluntários e pessoas ocupadas, e vão revisar assim que puderem. Se você não recebeu resposta em 7 dias, marque @exercism/reviewers em um comentário novo no PR, e isso vai chamar a atenção de uma equipe maior.

Obrigado mais uma vez por contribuir com o Exercism. Esperamos que seja uma experiência divertida e valiosa!