Gol
La nostra procedura di revisione ha diversi obiettivi:
- Garantisci un codice di alta qualità sia per la funzionalità che per la leggibilità.
- Rileva i bug, perché accadono.
- Mantieni uno stile coerente, in modo che sia facile iniziare a lavorare in qualsiasi parte del codebase.
Tutto il codice inserito negli esempi di blockly e nei elementi principali di Blockly viene sottoposto a revisione, a prescindere dal fatto che sia stato scritto dai collaboratori della community o dai membri del team di Blockly.
In qualità di revisori, il nostro obiettivo è collaborare con te per apportare le modifiche necessarie nel miglior modo possibile. In qualità di collaboratori, ti chiediamo di interagire con noi in modo che le tue richieste vengano esaminate e unite.
Il processo
Il processo di revisione del PR è composto da più fasi:
Assignment
Quando arriva la tua richiesta di pull, il membro disponibile del team di Blockly assegna un revisore.
I revisori vengono scelti in base alle competenze e alla distribuzione uniforme del carico di lavoro.
Potrebbero essere necessari alcuni giorni per l'assegnazione di un revisore e qualche giorno in più per ottenere una revisione. Non preoccuparti, è normale.
Feedback
Durante la fase di feedback, un revisore lascia suggerimenti per le modifiche al tuo PR. Potrebbero essere semplici operazioni per rendere il codice conforme alla guida di stile per JavaScript di Google. Oppure potrebbero essere più ampi, come la richiesta di riorganizzare le definizioni delle funzioni.
Consigliamo ai revisori di utilizzare le revisioni del codice di GitHub (anziché inserire singoli commenti) in modo da ricevere un'unica notifica anziché diverse.
Discussione
La fase di discussione è la tua occasione per rispondere al feedback. Forse uno dei commenti della recensione non era chiaro: ora hai la possibilità di chiedere chiarimenti. O forse il revisore ha richiesto una modifica, ma pensi che avrà ripercussioni: ora hai la possibilità di trovare un compromesso.
Revisione
La fase di revisione è il punto in cui devi apportare modifiche al tuo PR. In genere queste modifiche sono il risultato di qualcosa che il revisore ha detto nella fase di feedback.
Una volta completate le revisioni, può essere utile taggare il revisore chiedendogli di ricontrollare.
Ripetizioni
Dopo la fase di revisione, il revisore ha un'altra possibilità di inviare feedback e il processo inizia dall'inizio.
Spesso una seconda revisione è semplice e si concentra su nit come punteggiatura e stile del codice. A volte, però, una seconda revisione può risultare molto complessa. Il tuo primo recensore potrebbe anche chiedere a qualcun altro di dare un'occhiata, per avere un punto di vista nuovo.
Unisci!
La fase di unione è la tua occasione per festeggiare. Hai creato una modifica, la discussione e la revisione e alla fine l'hai unita. Questo è un grande risultato che molte persone non iniziano mai, figuriamoci portare a termine.
Grazie per tutto il tuo duro lavoro per migliorare Blockly. E congratulazioni!