Convenções do Changelog
Convenções, versionamento e política de breaking changes da API Conta Simples
Sobre o changelog
O changelog documenta todas as mudanças significativas na API Conta Simples, incluindo novas funcionalidades, alterações e correções. Seguimos o padrão Keep a Changelog.
Convenções
Cada release é documentada com os seguintes tipos de mudança:
| Tipo | Descrição |
|---|---|
| Added | Novas funcionalidades |
| Changed | Mudanças em funcionalidades existentes |
| Deprecated | Funcionalidades que serão removidas em versões futuras |
| Removed | Funcionalidades removidas |
| Fixed | Correções de bugs |
| Security | Correções de vulnerabilidades |
Versionamento
A API segue Semantic Versioning:
- MAJOR: Mudanças incompatíveis (breaking changes)
- MINOR: Novas funcionalidades compatíveis
- PATCH: Correções compatíveis
Breaking changes são comunicados com mínimo de 90 dias de antecedência e documentados no changelog.
Notificações de mudanças
Como ser notificado
Parceiros cadastrados recebem notificações de mudanças por e-mail.
Breaking changes
Para mudanças incompatíveis, seguimos este processo:
Anúncio (D-90)
Comunicação via e-mail e entrada no changelog com label Deprecated.
Documentação (D-60)
Guia de migração disponibilizado com exemplos de código.
Lembrete (D-30)
Novo comunicado reforçando a mudança.
Implementação (D-0)
Mudança entra em vigor. Endpoint/feature antigo deixa de funcionar.
Feedback
Tem sugestões para a API ou documentação?
Suporte & Contato
Envie seu feedback através dos canais de suporte.
Last updated 2 days ago
Built with Documentation.AI