Sembrano un post piuttosto banale, ma effettivamente tante volte mi viene ancora chiesto come sia possibile chiudere una GitHub Issue direttamente da visual studio code. Ripubblico un post di qualche anno fa.
Per chiudere le issue di GitHub direttamente da Visual Studio Code, un utente può ottimizzare il proprio flusso di lavoro e gestire il progetto senza dover passare continuamente dal browser. Questo metodo, oltre a essere efficiente, mantiene anche uno storico del repository pulito e ben documentato.
Il concetto chiave: le parole magiche nei commit
GitHub offre una potente funzionalità che permette di chiudere automaticamente le issue. Questo avviene quando si include una parola chiave specifica nel messaggio di commit, seguita da un riferimento all’issue (ad esempio, #42). Il sistema riconosce queste parole e, una volta che le modifiche vengono spinte sul repository, esegue l’azione corrispondente.
Le parole chiave che si possono utilizzare sono diverse e indicano lo stato o la natura dell’azione:
- close, closes, closed: per chiudere un’issue in modo generico.
- fix, fixes, fixed: per segnalare che il commit ha risolto un bug.
- resolve, resolves, resolved: per indicare che il problema è stato risolto.
Il processo da Visual Studio Code
Ecco i passaggi che un utente deve seguire per applicare questo metodo.
1. Apportare le modifiche al codice
L’utente deve prima di tutto scrivere il codice necessario per risolvere il problema.
2. Preparare le modifiche per il commit
Una volta completate le modifiche, si apre la vista Source Control (l’icona di Git) in Visual Studio Code. Qui, l’utente deve mettere in stage i file modificati, cliccando sull’icona + accanto a ciascun file o all’intestazione Changes.
3. Scrivere il messaggio di commit
Questo è il passaggio più importante. Nella casella del messaggio, l’utente deve inserire una delle parole chiave, seguita dal simbolo # e dal numero dell’issue.
- Esempio: Per chiudere l’issue #42, un messaggio di commit potrebbe essere:
Fixes #42 - Corretto un bug nel processo di autenticazione.
È possibile fare riferimento a più issue nello stesso commit, ad esempio: Closes #15, #16, #17 - Aggiornate le librerie e risolti problemi di compatibilità.
4. Effettuare il commit e il push
Dopo aver scritto il messaggio, l’utente deve eseguire il commit. Le modifiche sono ora salvate localmente. Per chiudere l’issue, l’utente deve fare il push delle modifiche sul repository remoto di GitHub.
Una volta che il push è stato completato, GitHub scansionerà il messaggio, riconoscerà la parola chiave e chiuderà automaticamente l’issue collegata. Inoltre, aggiungerà un commento che riporta il commit che ha risolto il problema, mantenendo lo storico del progetto chiaro e ben organizzato.
Questo metodo rappresenta un modo efficiente e professionale per gestire i progetti su GitHub direttamente dal proprio ambiente di sviluppo.