Guia de pull requests para contribuidores


Obrigado por quereres contribuir para o Exercism! Antes de criares um pull request, lê o guia como fazer um excelente pull request, que te ajuda com a parte não técnica dos pull requests, para que tenhas uma boa experiência e ajudes ao mesmo tempo a nossa equipa de manutenção.

Este documento contém algumas orientações adicionais, específicas do Exercism, para diferentes tipos de pull requests.

Pull requests de exercícios

Criar um pull request para um exercício de conceito ou um exercício de prática pode ser intimidante, dadas as muitas regras à volta deste tipo de exercícios. Por esse motivo, um maintainer pode demorar duas a três horas a fazer a revisão, que pode dar origem a dezenas de comentários.
Para te ajudar, haverá um revisor principal a comentar o teu pull request.

Não desanimes com o número de comentários de revisão; é perfeitamente normal que um exercício passe por várias reescritas até chegar a algo com que tu e o revisor principal fiquem satisfeitos.

Recomendações

Aqui ficam algumas recomendações para agilizar ainda mais o processo.

Lê a documentação

Antes de criares um pull request para um exercício, certifica-te de que lês a documentação dos exercícios de conceito ou a documentação dos exercícios de prática, conforme o caso. Ler a documentação com antecedência ajuda imenso: a revisão terá menos comentários e o teu pull request será integrado muito mais depressa.

Analisa os exercícios existentes (se houver)

Se o track já tiver exercícios, dedica algum tempo a estudá-los para veres como são e como estão estruturados.

Pull requests de exercícios de prática

Pensa se a alteração pertence mesmo ao problems-specifications

Parte do conteúdo de um exercício de prática (como a sua introdução) vem dos seus metadados (partilhados), definidos no repositório problem-specifications. Se pretendes atualizar esse conteúdo, pensa se a alteração também pode beneficiar outros tracks. Se sim, abre antes um pull request aos metadados do exercício no repositório problem-specifications.

Recomendações gerais

Evita fazer revisões não solicitadas

Todas as revisões de pull requests são feitas por um (ou mais) maintainers do track, uma vez que são eles os responsáveis por aprovar todas as alterações ao repositório. O facto de serem os maintainers a fazer a revisão também ajuda a evitar comentários contraditórios para quem escreveu o pull request.

Podes, naturalmente, deixar um comentário para oferecer ajuda na revisão (sobretudo em pull requests maiores) ou colocar questões, caso repares em algo que pareça um erro.