Le pull request (PR) sono il modo in cui sottoponi le modifiche che proponi a una parte del codice di Exercism.
Se stai leggendo questa pagina e stai preparando una PR, grazie!
Questa guida vuole aiutarti con il lato non tecnico delle PR, così che tu possa fare una bella esperienza e allo stesso tempo dare una mano al nostro team di maintainer.
Cosa aspettarsi
Il processo per le PR è il seguente:
- Sottoponi una PR
- Uno o più maintainer esaminano la PR e lasciano dei commenti con i suggerimenti.
In alcuni casi potrebbero discutere la PR nel suo complesso, per capire se sia davvero la cosa giusta da aggiungere.
- La tua PR viene unita e ricevi "Reputazione" sul sito.
Oppure la tua PR viene chiusa.
Come faccio a far unire una PR?
Ci sono alcune cose che puoi fare in anticipo per aumentare le probabilità che la tua PR venga unita con modifiche minime.
La cosa più importante è assicurarti, prima di sottoporre la PR, che i maintainer accoglieranno favorevolmente le modifiche che stai facendo.
Il modo più semplice è aprire prima una Issue su GitHub, spiegando cosa intendi fare e chiedendo se i maintainer sono aperti a quelle modifiche.
Se trovi un Task sul sito di Exercism, non c'è bisogno di aprire una nuova Issue.
Puoi commentare la Issue esistente per dire che te ne occuperai e poi procedere.
La seconda cosa da assicurare è che tu lasci una descrizione chiara all'interno della PR quando la apri.
Le PR senza descrizione sono incredibilmente frustranti per i maintainer, che non hanno il contesto quando leggono il codice.
Dicci perché hai fatto le modifiche, inserisci il link alla Issue di cui parla la PR, spiega i compromessi a cui hai dovuto scendere, ecc.
Infine, assicurati che la tua PR contenga solo modifiche relative a un singolo miglioramento.
Se hai più miglioramenti, suddividili in più PR.
Così i maintainer possono esaminarla più facilmente e più in fretta, e anche per te sarà più semplice.
Quanto devo aspettare?
Normalmente i maintainer esamineranno la tua PR entro qualche giorno.
Per favore, non continuare a riportare in cima la PR con commenti aggiuntivi durante la prima settimana: i nostri maintainer sono volontari e hanno molto da fare, e la esamineranno appena possibile.
Se non ricevi risposta entro 7 giorni, tagga @exercism/reviewers in un nuovo commento sulla PR, e questo avviserà una squadra più ampia.
Grazie ancora per aver contribuito a Exercism.
Speriamo che sia un'esperienza divertente e preziosa!
