O que é um Changelog?
Um registro de alterações é um registro detalhado das alterações feitas em um projeto, geralmente incluindo correções e novos recursos. Cada arquivo ou documento em um projeto pode incluir seu próprio log de alterações, além de um log mestre do projeto. Um changelog geralmente consiste em uma lista cronológica detalhando as alterações que foram feitas e quem as fez. Os registros de alterações são usados pelos desenvolvedores na criação e manutenção de projetos de software, hardware, web e documentação.
Os arquivos de registro de alterações geralmente são organizados em parágrafos que descrevem todas as alterações associadas a um objetivo específico. Cada parágrafo geralmente começa com a data da alteração, o nome do autor e o endereço de email. O nome de cada arquivo modificado é listado, juntamente com a função ou seção que foi alterada. Um breve motivo com alguns detalhes sobre a alteração também é fornecido com freqüência. Os registros de alterações são vitais em projetos que envolvem muitos desenvolvedores ao longo do tempo, como software de código aberto.
As alterações no projeto de software também podem ser registradas automaticamente com um sistema de controle de revisão de código-fonte. Esses sistemas geralmente rastreiam as alterações feitas nos arquivos de código e projeto, a fim de reconstruir com eficiência o software em desenvolvimento. Eles mantêm seus próprios arquivos de registro de alterações internos e podem gerar registros legíveis por humanos de todos os arquivos alterados. Esses sistemas geralmente incluem automaticamente comentários especialmente marcados nos arquivos de código em seus relatórios de alterações. Isso permite que um registro útil de alterações específicas no código-fonte seja mantido.
Um projeto de documentação também pode incluir arquivos de registro de alterações ou simplesmente uma lista de revisões no documento principal. Os processadores de texto geralmente incluem um mecanismo de rastreamento de alterações que indica todas as alterações feitas, até o último caractere. Por outro lado, um registro de alterações de documentos pode fornecer um nível mais geral de rastreamento de revisão. Algumas ferramentas de documentação podem criar e manter essas informações automaticamente. Eles podem solicitar ao escritor informações sobre alterações e incluí-lo em uma seção do documento ou mantê-lo em um arquivo separado.
Projetos de hardware de computador podem usar arquivos de registro de alterações para rastrear modificações em esquemas, diagramas e arquivos de simulador. Os logs também são utilizados pelos web designers para rastrear alterações no site e alterações de código. Os esforços de gerenciamento de projetos de todos os tipos também podem se beneficiar dos registros de modificação. Um changelog é útil em qualquer projeto em que possa ser importante entender como as versões anteriores são diferentes das atuais.
As notas de versão geralmente são baseadas nos registros de alterações do projeto, mas geralmente são focadas em correções de erros e aprimoramentos do produto. Eles são frequentemente escritos em um nível mais geral e podem discutir o impacto das alterações nos usuários do produto. Eles também podem incluir instruções sobre como recriar problemas específicos e descrever testes realizados para verificar as correções. Em geral, as notas de versão abordam a funcionalidade do produto, em vez de modificações individuais em arquivos específicos do produto.