Un programmatore informatico smart deve necessariamente saper utilizzare GitHub. Per iniziare una carriera come developer, infatti, Github risulta un tool indispensabile da conoscere.
Ma GitHub cos’è?
GitHub è una piattaforma di hosting di codice sorgente basata su Git, un sistema di controllo di versione distribuito. È ampiamente utilizzato da sviluppatori di software e team di sviluppo per gestire il controllo delle versioni dei loro progetti software.
GitHub come funziona?
GitHub facilita la collaborazione tra sviluppatori e team distribuiti. Gli sviluppatori possono clonare (copiare) i repository di altri, apportare modifiche e proporre queste modifiche attraverso “pull request” e “pushare” i commit delle loro modifiche sul repository. E tutti possono visualizzare e “pullare” queste modifiche! Inoltre, GitHub offre strumenti di gestione dei progetti, tra cui bacheche Kanban, strumenti di tracciamento dei problemi e integrazioni con strumenti di automazione, che aiutano a organizzare e monitorare lo sviluppo del software. GitHub utilizza il sistema di controllo di versione Git per tenere traccia delle modifiche al codice sorgente di un progetto. Questo permette ai collaboratori di lavorare su diverse versioni del codice in parallelo, mantenendo un registro completo delle modifiche apportate nel tempo.
Un aspirante web developer non può fare a meno di un tool come questo!
In questo articolo vedremo 3 best practices per scrivere meglio un commit all’interno della repository di GitHub. Ma partiamo dalle basi!
Perché scrivere commit GitHub migliori?
Una buona cronologia dei commit aiuta gli altri (e te, futuro sviluppatore web) a capire meglio il tuo codice e come è arrivato a quel punto.
Scrivere un buon commit è come scrivere dei commenti esplicativi. Va’ scritto in modo tale da poter capire anche in futuro perché è stato fatto quel commit e cosa contiene. Better-commits e le Conventional Commit Guidelines forniscono un modo per formattare i commit in modo coerente. Questo può portare a rendere i commit più facili da leggere e da capire.
3 best practices per scrivere commits migliori su GitHub
Vediamo, finalmente, insieme 3 good habit che possono condurre alla stesura di commit sensati.
- Descrivere nuove feature
Il testo deve spiegare cosa è cambiato, compreso il nome della proprietà da abilitare. Al commit viene fatto riferimento nel footer, che collega il problema di Github con la corrispondente richiesta pull.
feat(tools): #3 dedurre problemi from branch
Se commit_type.infer_value_from_branch è attivato,
Proverà a dedurre il problema dal nome del branch. Consultare la documentazione per ulteriori dettagli.
Chiuso: #3
- Cambiamenti drastici
Un punto esclamativo dopo il nome o il tipo e prima dei due punti attira l’attenzione sul commit. L’etichetta “BREAKING CHANGE” spiega quale è stata la modifica drastica.
Questo potrebbe essere esteso per includere un testo opzionale. Spiegare un percorso per migrare dal Nodo 6 e risolvere la modifica.
chore!: drop dal Nodo 6 della repository
BREAKING CHANGE: ….
- Rapidi cambiamenti alla documentazione
docs: correggere la tabulazione nella sezione default del readME.
Come sviluppatore di siti web, o software developer per essere più generici, la programmazione informatica necessita di questo tipo di accorgimenti, specialmente se si lavora su un progetto a cui diverse persone collaborano.
Saper scrivere un commit non vuol dire soltanto saper collaborare, ma anche essere consapevole del proprio lavoro, di quello degli altri, mostrando una certa dimestichezza con tool che non riguardano soltanto la scrittura del codice.