IMP — CHG: CHANGELOG & Release Notes (B)
CHG — CHANGELOG
Seção intitulada “CHG — CHANGELOG”Segue o formato Keep a Changelog + SemVer. Toda versão publicada deve ter entrada no CHG. Histórias implementadas são vinculadas pelo seu id.
Exemplo de entrada
Seção intitulada “Exemplo de entrada”## [1.2.0] — 2026-04-11
### Adicionado- ESP-HNU-0001: Registro de solicitação de serviço- ESP-HAI-0001: Autenticação gov.br nível Prata
### Corrigido- ESP-HRD-0002: Regra de elegibilidade com renda per capita
### Segurança- IMP-API-0001: Timeout de 5s em chamadas externasSeções do CHANGELOG
Seção intitulada “Seções do CHANGELOG”| Seção | Quando usar |
|---|---|
Adicionado | Nova funcionalidade ou história implementada |
Modificado | Mudança em funcionalidade existente |
Descontinuado | Funcionalidade que será removida em versão futura |
Removido | Funcionalidade removida definitivamente |
Corrigido | Correção de defeito |
Segurança | Correção de vulnerabilidade |
REL — Release Notes
Seção intitulada “REL — Release Notes”Documento público resumindo a versão entregue ao usuário final. Derivado do CHG, mas em linguagem de negócio.
---id: IMP-REL-0001tipo: RELtitulo: "Release Notes — v1.2.0"status: publicadoautor: fulano.de.taldata: 2026-04-11versao: "1.2.0"publico-alvo: usuario-final---- O número de versão segue SemVer (
MAJOR.MINOR.PATCH): major para mudanças incompatíveis, minor para novas funcionalidades, patch para correções. - Toda entrada do CHG deve referenciar ao menos um
idde história ou artefato. - A versão
[Unreleased]é mantida no topo e promovida quando há release.