Grazie per voler contribuire a Exercism!
Prima di creare una pull request, leggi la guida come fare un'ottima pull request, che ha lo scopo di aiutarti con il lato non tecnico delle pull request, così da vivere un'ottima esperienza e, allo stesso tempo, aiutare il nostro team di manutentori.
Questo documento contiene alcune linee guida aggiuntive, specifiche di Exercism, per i diversi tipi di pull request.
Pull request per gli esercizi
Creare una pull request per un esercizio concettuale o un esercizio pratico può essere scoraggiante, viste le tante regole che circondano questi tipi di esercizi.
Per questo motivo, a un manutentore la revisione può richiedere due o tre ore e produrre decine di commenti.
Per aiutarti, ci sarà un revisore principale che commenterà la tua pull request.
Non scoraggiarti per il numero di commenti di revisione: è del tutto normale che un esercizio passi attraverso diverse riscritture prima di arrivare a qualcosa che soddisfi sia te sia il revisore principale.
Consigli
Ecco alcuni consigli per rendere il processo ancora più snello.
Leggi la documentazione
Prima di creare una pull request per un esercizio, assicurati di leggere la documentazione sugli esercizi concettuali o la documentazione sugli esercizi pratici, a seconda del tipo di esercizio.
Leggere prima la documentazione aiuta moltissimo: le revisioni avranno meno commenti e la tua pull request verrà unita molto prima.
Esamina gli esercizi esistenti (se ce ne sono)
Se il track ha già degli esercizi, prenditi un po' di tempo per studiarli e scoprire che aspetto hanno e come sono strutturati.
Pull request per gli esercizi pratici
Valuta se la modifica appartiene davvero a problems-specifications
Alcuni contenuti di un esercizio pratico (come l'introduzione) provengono dai suoi metadati (condivisi), definiti nel repo problems-specifications.
Se intendi aggiornare questi contenuti, chiediti se la modifica potrebbe essere utile anche ad altri track.
In tal caso, apri invece una pull request per i metadati dell'esercizio nel repo problems-specifications.
Consigli generali
Evita di fare revisioni non richieste
Tutte le revisioni delle pull request sono fatte da uno (o più) manutentori del track, perché sono loro a dover approvare ogni modifica al repository.
Il fatto che siano i manutentori a fare la revisione aiuta anche a evitare feedback contrastanti per chi ha aperto la pull request.
Naturalmente sei libero di lasciare un commento per offrire aiuto con la revisione (soprattutto se la pull request è grande) o per fare domande nel caso in cui noti qualcosa che sembra un errore.
