Code review e approvazioni

Le revisioni del codice sono un elemento fondamentale dello sviluppo software moderno. Consistono nell'esame sistematico del codice sorgente da parte dei colleghi, allo scopo di individuare e correggere gli errori sfuggiti nella fase iniziale di sviluppo.

Gli obiettivi principali includono:

• Migliorare la qualità del codice: individuare tempestivamente bug, vulnerabilità di sicurezza e difetti di progettazione.
• Condividere le conoscenze: diffondere la comprensione del codebase all'interno del team.
• Affiancamento: gli sviluppatori senior possono guidare quelli junior e tutti possono imparare da prospettive diverse.

Su GitHub, il processo di revisione del codice segue generalmente questi passaggi:

1. L'autore crea una Pull Request (PR) con le proprie modifiche.
2. L'autore assegna i reviewer o ne richiede la revisione.
3. I reviewer esaminano il codice, lasciando commenti e suggerimenti.
4. L'autore affronta il feedback, inviando nuovi commit al branch della PR.
5. Quando sono soddisfatti, i reviewer approvano le modifiche.
6. Infine, la PR viene integrata nel branch principale.

Una buona revisione del codice non consiste solo nel trovare bug, ma nel migliorare lo stato complessivo del progetto. Durante la revisione, consideri:

• Correttezza: il codice esegue ciò che dovrebbe? Sono presenti casi limite?
• Leggibilità: è facile da comprendere? I nomi delle variabili sono chiari?
• Manutenibilità: in futuro sarà facile per altri modificare o estendere questo codice?
• Prestazioni: ci sono inefficienze evidenti?
• Sicurezza: introduce vulnerabilità?

In qualità di reviewer, il feedback dovrebbe essere sempre costruttivo e rispettoso. Ricordi che sta esaminando il codice, non la persona che lo ha scritto.

Suggerimenti per fornire feedback:

• Sia specifico: indichi le righe di codice esatte.
• Spieghi il 'perché': non si limiti a dire 'modifichi questo'; spieghi perché dovrebbe essere modificato.
• Proponga soluzioni: offra approcci alternativi o frammenti di codice.
• Sia gentile: utilizzi un linguaggio cortese e presuma la buona fede.

GitHub offre strumenti efficaci per semplificare il processo di revisione:

• Commenti sulle righe: faccia clic su una riga nella scheda 'Files changed' per aggiungere direttamente un commento.
• Suggerimenti: può proporre modifiche specifiche al codice che l'autore può applicare con un solo clic.
• Revisione riepilogativa: al termine, può inviare una revisione riepilogativa con lo stato 'Comment', 'Approve' o 'Request changes'.

I suggerimenti sono particolarmente utili per piccoli miglioramenti chiari:

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Se è l'autore di una Pull Request, rispondere al feedback è fondamentale. Dimostra che partecipa attivamente e si impegna a migliorare il codice.

Quando affronta i commenti:

• Riconosca il feedback: risponda a ogni commento, anche solo per dire 'Buon punto!' o 'Fatto'.
• Apporti le modifiche: invii nuovi commit al branch della PR. GitHub aggiornerà automaticamente la PR.
• Risolva le conversazioni: dopo aver affrontato un commento, lo contrassegni come 'Resolved' su GitHub.
• Faccia domande: se non comprende un suggerimento, chieda chiarimenti.

Lo stato 'Approve' indica chiaramente che un reviewer è soddisfatto delle modifiche apportate a una Pull Request. Molti repository sono configurati per richiedere almeno una o più approvazioni prima che una PR possa essere integrata.

Un'approvazione indica che, secondo il reviewer, il codice:

• Soddisfa i requisiti.
• È scritto bene e facilmente manutenibile.
• Ha risolto tutte le problematiche significative.

È il via libera all'integrazione.

A volte una Pull Request richiede ulteriore lavoro prima di poter essere integrata. In questi casi, un reviewer può scegliere 'Request changes' come stato della revisione.

Questo stato comunica chiaramente che:

• Ci sono problemi bloccanti da risolvere.
• La PR non può essere integrata finché non vengono apportate queste modifiche e il reviewer non concede una nuova approvazione.

Utilizzi questa opzione quando i problemi sono significativi e impediscono di accettare il codice.

Per ottenere il massimo dalle revisioni del codice, autori e reviewer dovrebbero seguire alcune buone pratiche:

• Mantenga le PR di piccole dimensioni: le PR più piccole sono più facili e rapide da esaminare.
• Fornisca descrizioni chiare: gli autori dovrebbero fornire descrizioni dettagliate della PR e il relativo contesto.
• Sia tempestivo: i reviewer dovrebbero cercare di esaminare rapidamente le PR e gli autori dovrebbero rispondere senza ritardi.
• Automatizzi ciò che è possibile: utilizzi linter e test automatizzati per individuare i problemi semplici prima della revisione.
• Impari dalle revisioni: consideri ogni revisione un'opportunità per imparare e migliorare.

In base a ciò che abbiamo imparato, quali delle seguenti sono considerate buone pratiche per partecipare alle revisioni del codice?

Ha esplorato il mondo delle revisioni del codice e delle funzionalità di approvazione di GitHub. Abbiamo visto perché le revisioni sono fondamentali per la qualità del codice e la condivisione delle conoscenze, il tipico flusso di revisione e gli elementi chiave di buone pratiche di revisione.

Ricordi di fornire sempre feedback costruttivo, utilizzare gli strumenti di GitHub come i suggerimenti e seguire le buone pratiche sia durante la revisione sia quando risponde al feedback. Gli stati 'Approve' e 'Request changes' sono segnali fondamentali per gestire efficacemente le proprie PR.

Continui a esercitare queste competenze per diventare un collaboratore prezioso.