Le richieste di pull sono la linfa vitale di un repository. Mantengono tutto in salute e in movimento. In questa pagina viene spiegato come creare un PR completo e facile da esaminare, che aumenta le probabilità di unione.
Ecco i passaggi che puoi seguire per assicurarti di creare le migliori relazioni pubbliche possibile.
- Comunica
- Preparati
- Riduci dimensioni ridotte
- Tienilo pulito
- Verifica la modifica
- Comunicazione (pt2)
Comunica la novità
Prima di iniziare a scrivere codice, è utile comunicare con il team principale in modo che sappiano cosa ti interessa.
Se c'è un problema che ti interessa, pubblica un commento in merito per dire che inizierai a lavorare al problema. Questo assicura che non ci siano più persone che lavorano alla stessa cosa. Un membro del team risponderà per confermare che è tuo.
Se hai un'idea che non è oggetto di un problema, scrivine una prima di iniziare. In questo modo, il team ha la possibilità di discutere del modo migliore per implementare il cambiamento prima di iniziare a costruire, risparmiando così lavoro sul lungo periodo.
Preparati
Se è la prima volta che contribuisci a Blockly o blockly-samples, inizia dalla pagina di configurazione dello sviluppo.
Riduci le dimensioni
Cerca sempre di apportare modifiche brevi e mirate. Preferiremmo esaminare diversi PR di piccole dimensioni piuttosto che uno solo. Ecco alcune buone regole generali:
- Risolvi un problema. Non tentare di affrontare più problemi contemporaneamente.
- Limita l'ambito. In genere un PR dovrebbe richiedere meno di 8 ore (a seconda della tua conoscenza del codebase).
- Utilizza i commit. Se il tuo PR ti sembra un po' grande, suddividi le modifiche in gruppi logici utilizzando i commit Git.
Pulisci il cinturino
Perché ti interessa lo stile del codice? Il servizio è a lungo termine e lo stile costante semplifica la manutenzione. Lo stile si riferisce al modo in cui assegni i nomi alle variabili, ma spiega anche come strutturare il codice, scrivere commenti e altro ancora. Laddove possibile, utilizziamo strumenti come eslint per automatizzare i controlli degli stili.
Oltre a eslint, segui queste guide:
- Guida di stile per JavaScript di Google.
- Guida ai messaggi di commit
- Linee guida sull'utilizzo delle API Blockly
- Guida di stile codelab
Testa la modifica
Prima di creare un PR, devi sempre verificare che le modifiche funzionino, in modo da non dover tornare indietro e sistemare le cose in un secondo momento. Ecco alcune idee per testare le diverse categorie di progetti:
- Per i plug-in: scrivi test moca automatici che coprono le modifiche.
- Ad esempi: testa manualmente tutte le funzionalità dimostrate.
- Per i codelab: segui l'intero tutorial in un ambiente pulito e testa qualsiasi codice di esempio fornito.
Comunica la novità
Questa è l'ultima parte, probabilmente la più importante, della creazione di un PR: scrivere il riassunto.
Scrivere un buon riepilogo PR aiuta gli altri sviluppatori a esaminare le tue modifiche, aumentando le probabilità che vengano accettate più rapidamente.
Il riepilogo deve includere:
- Il problema a cui si riferisce il tuo PR.
- Cosa cambia il tuo PR.
- Come hai testato la modifica.
- Tutto ciò che vuoi che i revisori esaminino.
- Qualsiasi altra informazione che ritieni necessaria ai revisori.
Se al momento della creazione della richiesta segui il modello PR, non devi fare altro che procedere. Ricordati solo di essere il più conciso e completo possibile.
Buona programmazione!