Guia de pull request para contribuidores


Obrigado por querer contribuir com o Exercism! Antes de criar um pull request, leia o guia como fazer um ótimo pull request, que tem o objetivo de ajudar você com a parte não técnica dos pull requests, para que você tenha uma ótima experiência e ajude nossa equipe de manutenção ao mesmo tempo.

Este documento contém algumas diretrizes adicionais, específicas do Exercism, para diferentes tipos de pull request.

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, por causa das muitas regras em torno desses tipos de exercício. Por isso, a revisão pode levar de duas a três horas para quem mantém a trilha e pode gerar dezenas de comentários.
Para ajudar você, haverá uma pessoa revisora principal comentando no seu pull request.

Não se desanime com a quantidade de comentários de revisão; é perfeitamente normal que um exercício passe por várias reescritas antes de chegar a algo que agrade tanto a você quanto à pessoa revisora principal.

Recomendações

Aqui vão algumas recomendações para deixar o processo ainda mais ágil.

Leia a documentação

Antes de criar um pull request para um exercício, leia a documentação de exercícios de conceito e a documentação de exercícios de prática. Ler a documentação com antecedência ajuda imensamente, pois as revisões terão menos comentários e seu pull request será mesclado muito mais rápido.

Analise os exercícios existentes (se houver)

Se a trilha já tiver exercícios, reserve um tempo para estudá-los um pouco e descobrir como eles são e como estão estruturados.

Pull requests de exercícios de prática

Considere se a mudança pertence mesmo ao problems-specifications

Parte do conteúdo de um exercício de prática (como a introdução) vem dos seus metadados (compartilhados), definidos no repositório problems-specifications. Se você pretende atualizar esse conteúdo, considere se a mudança também poderia beneficiar outras trilhas. Nesse caso, abra um pull request para os metadados do exercício no repositório problems-specifications.

Recomendações gerais

Evite fazer revisões não solicitadas

Todas as revisões de pull request são feitas por uma ou mais pessoas que mantêm a trilha, já que são elas que aprovam todas as mudanças no repositório. Quem mantém a trilha também faz a revisão, o que ajuda a evitar feedback conflitante para quem escreveu o pull request.

Você pode, claro, deixar um comentário para oferecer ajuda com a revisão (principalmente em pull requests maiores) ou levantar dúvidas caso note algo que pareça um erro.