Changelog
Objetivo
Registrar alterações relevantes no krameldocs, incluindo novas funcionalidades, correções, mudanças de configuração e modificações na documentação.
Como registrar alterações
Adicione uma nova entrada quando uma mudança relevante for publicada.
Organize as entradas da mais recente para a mais antiga e prefira descrições objetivas.
Categorias sugeridas:
- Adicionado: novas funcionalidades.
- Alterado: mudanças em comportamentos existentes.
- Corrigido: correções de defeitos.
- Segurança: melhorias ou correções de segurança.
- Removido: funcionalidades descontinuadas.
- Documentação: mudanças relevantes nos documentos.
Histórico inicial
Portal inicial
- Implementado o portal de documentação com Next.js e TypeScript.
- Separado o código da aplicação do repositório de conteúdo.
- Integrada a leitura de conteúdo hospedado no GitHub.
- Criada a navegação hierárquica a partir de
navigation.json. - Adicionado o processamento de Markdown com realce de sintaxe.
- Disponibilizada uma rota própria para imagens e anexos.
- Adicionadas configurações por variáveis de ambiente.
- Incluídos testes automatizados e verificações de qualidade.
Confirme esta lista com o histórico do Git antes de tratá-la como um registro completo de funcionalidades publicadas.
Modelo para novas versões
[Versão ou data]
- Adicionado: descreva a nova funcionalidade.
- Alterado: descreva a mudança de comportamento.
- Corrigido: descreva o problema resolvido.
- Segurança: descreva a melhoria relevante.
- Documentação: descreva as atualizações documentais.
Remova as categorias que não se aplicarem à entrada.
Boas práticas
- Registre alterações efetivamente realizadas.
- Evite incluir dados secretos ou informações sensíveis.
- Referencie versões ou commits quando isso facilitar a rastreabilidade.
- Diferencie funcionalidades disponíveis de melhorias planejadas.
- Atualize o changelog junto à publicação correspondente.
Relação com o Git
O histórico do Git permanece como referência para os detalhes completos das alterações no código e no conteúdo.
O changelog oferece uma visão resumida das mudanças importantes para quem utiliza ou mantém o projeto.