Revisioni del codice per diventare uno sviluppatore migliore
Nella mia esperienza, partecipare a una revisione del codice è il modo più efficace per salire di livello come sviluppatore. Se sei l'autore delle modifiche esaminate, puoi ottenere un feedback diretto dai tuoi colleghi. E se sei uno dei revisori, puoi imparare diversi approcci a cui potresti non aver pensato su come risolvere le implementazioni.
Ma dare e anche comprendere correttamente una revisione del codice è un'abilità che deve essere appresa. In questo articolo, elencherò semplicemente alcuni aspetti che considero quando fornisco e ricevo revisioni del codice. Dal mio punto di vista, hanno dimostrato di essere la scelta giusta per un ambiente di sviluppo collaborativo e accogliente.
Quello che definisco un buon codice
Ricorda che non c'è niente di più permanente di una soluzione temporanea.
Le seguenti metriche chiave mi guidano durante la scrittura e la revisione del codice.
- il codice è gestibile, ad es. nessun hack o soluzioni alternative per quanto ben documentato
- il codice è facilmente leggibile, quindi ragionare su di esso è molto più semplice
- il codice è testabile, migliorando così ulteriormente i due punti precedenti
Come dare una revisione del codice
Sii umile
Sbagliare non è un problema. Insistere sul fatto che hai ragione anche se oggettivamente non lo sei è un problema. Tieni sempre presente che potresti perdere qualcosa o semplicemente fraintendere il codice. Sii aperto al respingimento e sii umile per avere la possibilità di imparare qualcosa di nuovo.
Le revisioni del codice non sono personali
Ricorda: il codice viene prima di tutto. Potresti rivedere il codice di qualcuno in una situazione tesa in cui entrambi non siete dell'umore giusto per parlarvi o siete generalmente in disaccordo sul modo in cui funzionano le cose.
Le revisioni del codice non sono il luogo per sfogarsi o per ripagare le frustrazioni. L'unico scopo delle revisioni è di migliorare oggettivamente la qualità del codice. Il codice che esamini e che verrà unito è il prossimo codice legacy, quindi è importante lasciare da parte le cose personali e fornire una revisione obiettiva, indipendentemente da chi sia il recensore.
Le opinioni non sono recensioni
Una differenza fondamentale tra una buona recensione e solo un commento è che le recensioni tralasciano le opinioni. Ad esempio, non importa come appare lo stile del codice, purché sia manutenibile, facilmente leggibile e testabile. Se non sei sicuro che la tua recensione possa essere supponente, aggiungi semplicemente un commento in modo da poter discutere il punto con il tuo collega.
Le buone recensioni portano a buone discussioni
Sfidare una recensione può portare a grandi trasferimenti di conoscenze tra gli sviluppatori. Una determinata recensione non dovrebbe essere trattata come un commento finale, ma piuttosto come un punto di partenza per le discussioni per ottenere il quadro completo. Entrambi potreste perdere qualcosa e discutere delle critiche può solo migliorare le vostre intuizioni.
Le scadenze non contano
Non è sempre facile da applicare, ma saltare le revisioni del codice può potenzialmente creare un grosso debito tecnico che nessuno sarà disposto a ripulire. È importante mantenere la disciplina necessaria per fornire revisioni approfondite del codice anche se si sente il ticchettio dell'orologio. Potresti essere il prossimo sviluppatore a lavorare su questo pasticcio!
Usa i link per i riferimenti
Il confronto del codice recensito con quello esistente avviene abbastanza spesso. È quindi importante includere correttamente i riferimenti tramite link. Menzionare solo il luogo approssimativo in cui si trova il codice di riferimento non lo taglia.
Usa la funzione del tuo controllo del codice sorgente per evidenziare il codice su un ramo esistente e usa gli URL creati nella tua recensione come riferimento. Lo stesso vale per la documentazione esterna, ad esempio su MDN.
Come leggere una revisione del codice
Tutti i precedenti
Leggere le revisioni del codice del tuo codice ti rende uno sviluppatore migliore quando segui tutti i punti sopra menzionati. Sii umile, non prendere le critiche sul personale e cerca di capire cosa indica una recensione per comprendere meglio il quadro generale.
Un'opinione personale su come essere obiettivi
Questo articolo riflette il mio approccio personale alle revisioni del codice. I punti delineati sono solo il culmine della mia esperienza come sviluppatore in team grandi e piccoli, sia a livello locale che internazionale. Hanno dimostrato di funzionare, portando a un codice migliore e dandomi l'opportunità di imparare direttamente dagli altri.
