Changelog

Um changelog ( anglicismo ), ou log de mudanças é uma lista de mudanças, geralmente apresentada em ordem decrescente de confirmação e agrupada por release.

Pode ser distribuído como um arquivo com o software, incluído na documentação ou colocado em um portal destinado aos desenvolvedores do projeto.

Cada entrada tem resumos sucintos das mudanças, às vezes acompanhados por metadados como o autor, um identificador de bug .

Exemplo

Ex .: para um projeto de contabilidade informatizado, pode-se imaginar

ChangeLog - Mise en conformité avec la terminologie du plan comptable (Vincent et Michel) - Bugs d'affichage des graphiques d'équilibre des comptes corrigés (Gaby) - Ajout de la fonction pour gérer plusieurs comptes (Sara) - Réparation des éventuelles failles de sécurités lors des échanges par le réseau (Stéphane et Raoul) - Orthographe dans la documentation (José)

Em uma situação ideal, os elementos presentes em um changelog são aqueles previstos na lista de tarefas . Na prática, geralmente há também muitas correções de bugs, devido a erros humanos ou eventos imprevistos de todos os tipos (lidar com um problema com o sistema, um driver, um problema de hardware, uma situação não planejada, etc.) e correções de segurança .

Gerenciamento de versão

Alguns gerenciadores de versão de software são capazes de gerar as informações relevantes como um changelog , tipicamente aqueles dos comandos tradicionais diff e commit . Além disso, um utilitário como o vc-dwim permite que você mantenha um arquivo ChangeLog que descreve as alterações feitas em arquivos sob controle de versão . É notavelmente compatível com Git , mercurial , bzr , CVS e SVN .

Notas e referências

  1. (em) "  vc-dwim  " em gnu.org ,24 de dezembro de 2011(acessado em 27 de março de 2013 )

Veja também