Pular para o conteúdo

O CHANGELOG

O que escrever, em que ordem, e a seção que quase todo mundo esquece.

O CHANGELOG é para quem vai atualizar, e a pergunta dessa pessoa é uma só: o que eu preciso mudar no meu código?. Por isso ele é organizado pelo efeito, e não pela ordem dos commits.

CHANGELOG.md
## 2.0.0

### Quebra — o que voce precisa mudar
- `total(itens)` foi removida. Use `calcular_total(itens)` — avisava desde a 1.4.

### Adicionado
- `calcular_frete(uf, peso)`.

### Corrigido
- `desconto` arredondava para baixo; agora arredonda para o mais proximo.

### Obsoleto — vai sair na 3.0
- `frete_fixo()`: use `calcular_frete`.
SeçãoPorque ela existe
Quebra (primeiro)é o que impede a atualização; escondê-la no meio é o que faz alguém atualizar e quebrar produção
Adicionadoo que se ganha
Corrigidoo comportamento que mudou — uma correção é uma mudança para quem dependia do defeito
Obsoletoa seção esquecida: é ela que dá tempo de migrar