Os Pull Requests (PRs) são a forma de submeteres as alterações que propões a alguma parte da base de código do Exercism.
Se estás a ler isto e a preparar um PR, obrigado!
Este guia pretende ajudar-te com a parte não técnica dos PRs, para que tenhas uma ótima experiência e ajudes ao mesmo tempo a nossa equipa de manutenção.
O que esperar
O processo dos PRs é o seguinte:
- Submetes um PR
- Um ou mais responsáveis reveem o PR e deixam comentários com sugestões.
Em alguns casos, podem discutir o PR no seu conjunto, para perceber se é de facto a coisa certa a acrescentar.
- O teu PR é integrado e recebes Reputação no site.
Ou o teu PR é fechado.
Como consigo que o meu PR seja integrado?
Há certas coisas que podes fazer desde o início para aumentar a probabilidade de o teu PR ser integrado com o mínimo de alterações.
O mais importante é garantires, antes de submeteres o PR, que os responsáveis vão receber bem as alterações que estás a fazer.
A forma mais fácil de o fazer é abrires primeiro uma Issue no GitHub, explicando o que pretendes fazer e perguntando se os responsáveis estão abertos a essas alterações.
Se encontrares uma Tarefa no site do Exercism, não precisas de abrir uma nova Issue.
Podes comentar a Issue existente a dizer que vais trabalhar nela e depois avançar.
A segunda coisa a garantir é que deixas uma descrição clara no PR quando o abres.
PRs sem descrição são incrivelmente frustrantes para os responsáveis, porque não têm contexto quando leem o código.
Diz-nos porque fizeste as alterações, liga à Issue a que o PR diz respeito, explica os compromissos que tiveste de assumir, etc.
Por fim, garante que o teu PR contém apenas alterações relativas a uma única melhoria.
Se tens várias melhorias, divide-as por vários PRs.
Assim, os responsáveis conseguem revê-las mais facilmente e mais depressa, e a tua vida também fica mais simples.
Quanto tempo devo esperar?
Normalmente, os responsáveis reveem o teu PR dentro de alguns dias.
Não estejas sempre a comentar o PR com mensagens extra durante a primeira semana. Os nossos responsáveis são voluntários e pessoas ocupadas, e vão revê-lo assim que puderem.
Se não tiveres resposta no prazo de 7 dias, marca @exercism/reviewers num comentário novo no PR, o que vai alertar uma equipa mais alargada.
Obrigado mais uma vez por contribuíres para o Exercism.
Esperamos que seja uma experiência divertida e valiosa!
