Colori da usare: Heading 1, Heading 2, Heading 3, SEMPRE, NON, E NON, Cose da enfatizzare
I link ai blocchi devono avere lo stesso colore dell’header al quale puntano (es. questo link punta a Git Flow e ha il suo stesso colore).
Il Branching Model che useremo sarà Git Flow, insieme al Lock System del plugin UE4GIT. Di seguito descriviamo in breve Git Flow, il sistema di Lock, e le best practices che vogliamo attuare per agevolare lo sviluppo.
Git Flow permette di separare i diversi aspetti dello sviluppo (release, bug fixing, etc) in maniera indipendente. Seguono alcune regole per usarlo al meglio:
Commit frequenti e piccoli: committare con frequenza tanti piccoli cambiamenti permette di avere maggior controllo sul proprio workflow e minimizzare il rischio di perdere lavoro. Incoraggiamo a committare anche cambiamenti atomici (singolo bugfix, creazione di una classe e della sua interfaccia, definizione di pochi metodi).
Documentare i propri commit: È importante documentare i propri commit per permettere di navigare la storia facilmente. Lo strumento principale per questo è aggiungere un commento significativo e breve che listi i cambiamenti eseguiti in maniera semplice. Non c’è bisogno di essere dettagliati, ma l’importante è essere completi. I commenti vanno scritti in Inglese.
Non tenere un branch aperto troppo a lungo: Per massimizzare la disponibilità delle nuove feature agli altri sviluppatori, è importante che i branch feature vengano mergiati quanto più in fretta sia possibile. Se una feature rimane aperta per troppo tempo ed ha tanti commit è un segno che probabilmente si sta lavorando a troppe cose contemporaneamente. In questi casi comunica con il resto del team per risuddividere meglio il lavoro.
Non pushare merge non funzionanti: Si applica ai merge delle feature su develop. Per quanto develop rimane un branch di sviluppo, è una buona pratica evitare di portarlo in uno stato non funzionante o in cui si sono persi dei dati. Per fare ciò, dopo aver mergiato e prima di pushare, controlla il progetto e assicurati che tutto sia funzionante; se ci sono errori correggili e fai un commit sul develop per ripararli prima di pushare se possibile.
Usare Sourcetree: Per minimizzare errori, gli sviluppatori meno esperti sono incoraggiati ad usare Sourcetree con il suo plugin per gestire autonomamente Git Flow, o un suo sostituto. A priori si incoraggia ad usare Sourcetree per omogenizzare il workflow.
Clicca questa bellissima icona ogni volta che vuoi lavorare di branch