Scrivere codice di qualità dovrebbe essere l'obiettivo primario di ogni sviluppatore che si rispetti. E, come scrivevo in un articolo sull'importanza della leggibilità del codice, far controllare il codice ad uno sviluppatore esterno prima del merge tramite le cosiddette "code review" è uno dei metodi più efficaci per garantire un codice di alta qualità.
GitHub, GitLab, Bitbucket... sono alcuni dei servizi più famosi che offrono un meccanismo di controllo del codice distribuito e che integrano la possibilità di svolgere le code review direttamente dal browser.
Nel 90% dei casi l'interfaccia offerte da queste piattaforme è più che sufficiente a fare una review ma non è così raro imbattersi in grossi cambiamenti che la UI non riesce a caricare tutti in un'unica volta.
Non sarebbe bello poter fare le code review direttamente da PHPStorm sfruttando tutte le potenzialità dell'IDE e soprattutto senza dover aprire il browser?
Bé, ho scoperto che si può!
Ma prima di mostrarti come fare mi presento: sono Lorenzo Millucci e sono un ingegnere del software che ama lavorare con Symfony e a cui piace condividere in questo blog le cose che impara. Ho anche un canale Telegram in cui ogni martedì condivido una mia riflessione su una notizia legata al mondo tecnologico!
Connettere PHPStorm a GitHub #
La prima cosa da fare per poter visionare le Pull Requests aperte da PHPStorm è collegare il proprio IDE a GitHub. Per farlo basta andare su:
File > Settings > Version Control > GitHub
E premere il tasto + in alto a destra.
Ci verranno chieste le credenziali dell'account (e il codice di accesso nel caso in cui sia attiva la two-factor authentication).
Visualizzare le pull requests #
Una volta completata la connessione con l'account per visualizzare le Pull Requests del progetto ti basta andare su:
VCS > Git > View Pull Requests
Visualizzare le pull requests aperte per il progetto
A questo l'IDE mostrerà l'elenco di tutte le Pull Request aperte nel repository del progetto. Selezionandone una sarà possibile visualizzare lo storico dei commit, l'elenco di tutti i cambiamenti e aggiungere nuovi commenti.
Di seguito trovi un paio di screenshot di come si mostra l'interfaccia dell'IDE quando si prova a fare una code review. (Ho preso come esempio la pull request #37595 di Symfony)
Summary della Pull Request
Aggiunta di un commento
NOTA: io in questo articolo mi sono riferito a PHPStorm perché è l'IDE che utilizzo quotidianamente. La procedura descritta dovrebbe essere replicabile al 100% su qualunque altro prodotto della JetBrains (WebStorm, IntelliJ Idea, PyCharm ecc...)
Conclusioni #
L'interfaccia web dei vari servizi di versioning del codice è molto buona e per diversi anni ho utilizzato solo quella per fare le code review ma da quando ho scoperto la possibilità di farle direttamente dall'IDE ho praticamente smesso di usarla. La possibilità di poter fare control+click per vedere la definizione di un metodo o la possibilità di utilizzare il potente motore di ricerca di PHPStorm sono delle comodità troppo grosse per poterle ignorare.
Sicuramente non sarà questa funzione a cambiarti la vita ma anche solo un 1% di miglioramento in una delle azioni che si svolgono frequentemente può portare a notevoli quantità di tempo risparmiato.
Se questo post ti è stato utile puoi farmelo sapere scrivendomi direttamente su Telegram. Inoltre ti invito ad iscriverti al mio canale Telegram e a seguirmi su Twitter per non perderti nemmeno un post del mio blog. A presto!