O que é um changelog?
Um changelog (registo de alterações) é um ficheiro que contém uma lista em ordem cronológica invertida das alterações mais relevantes para cada versão de um projeto.
Porque manter um changelog?
Para permitir às pessoas que usam e contribuem com o projeto, de ver exatamente quais alterações relevantes foram feitos entre cada publicação (ou versão) do projeto.
Mais detalhes em https://keepachangelog.com.
Cada entrada do changelog deve:
- referenciar o ticket (ou o PR se não houver um ticket correspondente);
- descrever claramente e de modo conciso as alterações incluídas no PR;
Para cada versão, indicar o número de versão, seguido da data, no formato ANO-MES-DIA.
As entradas são agrupadas por categoria. Estas são as categorias usadas no SPIP.
| Tipo de entrada | Significado |
|---|---|
| Added | Para as nocas funcionalidades |
| Changed | Para as alterações a funcionalidades preexistentes |
| Deprecated | Para as funcionalidades que serão removidas em breve |
| Removed | Para as funcionalidades que foram removidas |
| Fixed | Para correção de bugs |
| Security | No caso de vulnerabilidades |
Exemplo de Changelog simples
# Changelog
## 1.0.2 - 2023-07-25
## Fixed
- Não exibir o texto do modelo `icone` e colocá-lo como `title` do link
### Changed
- atualização do README.md agora que a doc está em contrib
## 1.0.1 - 2023-06-22
### Added
- inclusão de um CHANGELOG.md
### Changed
- compatibilidade SPIP 4.1+
- atualização da documentação em README.md
Exemplo de changelog completo
Para um exemplo mais completo, ver o do SPIP.