Implementare un log delle modifiche
Il concetto di log delle modifiche è abbastanza semplice: si tratta di un file con un elenco di modifiche apportate a un progetto, in genere in ordine di data. La suddivisione tipica consiste nel separare un elenco di versioni e quindi all'interno di ogni versione, mostrare:
- Aggiunta di funzionalità
- Funzionalità modificate/migliorate
- Funzionalità eliminate
Alcuni team pubblicheranno i log delle modifiche come post di blog; altri creeranno un file CHANGELOG.md in un repository GitHub.
Strumentazione automatizzata per il log delle modifiche
Anche se è possibile creare e gestire manualmente i log delle modifiche, è possibile prendere in considerazione l'uso di uno strumento di creazione automatizzato del log delle modifiche. Almeno come punto di partenza.
Uso di comandi GitHub nativi
Il comando git log può essere utile per la creazione automatica del contenuto. Esempio: creare una nuova sezione per versione:
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Log delle modifiche Git
Uno strumento standard è gitchangelog. Questo strumento è basato su Python.
Generatore di log delle modifiche di GitHub
Un altro strumento standard viene chiamato github-changelog-generator.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Questo strumento si basa su Gem.
È consigliabile usare i dati basati su log generati automaticamente?
La preferenza è sempre evitare di scaricare le voci di log in un registro delle modifiche. I log sono "rumorosi", quindi è facile generare una confusione che non aiuta.