Implementare un log delle modifiche
Il concetto di log delle modifiche e piuttosto semplice. Si tratta di un file che contiene un elenco di modifiche apportate a un progetto, in genere registrate in ordine di data. Viene solitamente suddiviso in un elenco di versioni separate e quindi all'interno di ogni versione sono presenti le informazioni seguenti:
- Funzionalità aggiunte
- Funzionalità modificate/migliorate
- Funzionalità eliminate
Alcuni team pubblicano i log delle modifiche come post di blog. Altri creano un file CHANGELOG.md in un repository di GitHub.
Strumenti automatizzati del log delle modifiche
I log delle modifiche possono essere creati e gestiti manualmente. È comunque possibile usare uno strumento di creazione automatizzato del log delle modifiche. Almeno come punto di partenza.
Uso dei comandi nativi di GitHub
Il comando git log può essere utile per creare contenuto automaticamente. Esempio: creare una nuova sezione per versione:
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Git changelog
Uno strumento standard è gitchangelog. Questo strumento è basato su Python.
GitHub changelog generator
Un altro strumento standard è denominato github-changelog-generator.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Questo strumento è basato su Gem.
È consigliabile usare i dati basati su log generati automaticamente?
La preferenza è sempre quella di evitare di scaricare voci di log in un log delle modifiche. I log sono "attivissimi", quindi è facile generare un disordine che non è utile.