Qu'est-ce qu'un changelog?
Un journal des modifications est un enregistrement détaillé des modifications apportées à un projet, comprenant souvent des correctifs et de nouvelles fonctionnalités. Chaque fichier ou document d'un projet peut inclure son propre journal des modifications, en plus d'un journal de projet principal. Un changelog consiste généralement en une liste chronologique détaillant les modifications apportées et leur auteur. Changelogs est utilisé par les développeurs pour la création et la maintenance de projets logiciels, matériels, Web et de documentation.
Les fichiers de changements sont généralement organisés en paragraphes décrivant toutes les modifications associées à un objectif spécifique. Chaque paragraphe commence souvent par la date de modification, le nom de l'auteur et l'adresse électronique. Le nom de chaque fichier modifié est répertorié, ainsi que la fonction ou la section qui a été modifiée. Une brève raison avec quelques détails sur le changement est également fournie fréquemment. Les changelogs sont essentiels dans les projets impliquant de nombreux développeurs au fil du temps, tels que les logiciels open source.
Les modifications de projet logiciel peuvent également être enregistrées automatiquement avec un système de contrôle de révision de code source. Ces systèmes suivent généralement les modifications apportées aux fichiers de code et de projet afin de reconstruire efficacement les logiciels en cours de développement. Ils conservent leurs propres fichiers de changelog internes et peuvent générer des enregistrements lisibles par l’homme de tous les fichiers modifiés. Ces systèmes incluent souvent automatiquement des commentaires spécialement marqués à partir des fichiers de code dans leurs rapports de modification. Cela permet de conserver un enregistrement utile de modifications spécifiques du code source.
Un projet de documentation peut également inclure des fichiers changelog ou simplement une liste de révisions dans le document principal. Les traitements de texte incluent souvent un mécanisme de suivi des modifications qui indique chaque modification effectuée, jusqu'au dernier caractère. En revanche, un journal des modifications de document peut fournir un niveau plus général de suivi des révisions. Certains outils de documentation peuvent créer et gérer automatiquement ces informations. Ils peuvent demander au rédacteur des informations sur les modifications et les inclure dans une section du document ou les conserver dans un fichier séparé.
Les projets de matériel informatique peuvent utiliser des fichiers changelog pour suivre les modifications apportées aux schémas, diagrammes et fichiers de simulation. Les concepteurs Web utilisent également les journaux pour suivre les modifications apportées au site Web et au code. Les efforts de gestion de projet de toutes sortes peuvent également bénéficier des enregistrements de modification. Un changelog est utile dans tout projet où il peut être important de comprendre en quoi les versions précédentes sont différentes des versions actuelles.
Les notes de publication sont généralement basées sur les changelogs du projet, mais sont souvent axées sur les corrections de bogues et les améliorations du produit. Ils sont souvent écrits à un niveau plus général et peuvent discuter de l'impact des modifications sur les utilisateurs du produit. Ils peuvent également inclure des instructions sur la manière de recréer des problèmes spécifiques et décrire les tests effectués pour vérifier les correctifs. En général, les notes de publication traitent des fonctionnalités du produit plutôt que de modifications individuelles dans des fichiers de produit spécifiques.