mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-31 01:34:18 +02:00
Updates from a real text reviewer
This commit is contained in:
parent
b6934c233b
commit
090276be05
@ -26,16 +26,16 @@ version: 0.3.0
|
||||
Para facilitar que usuários e contribuidores vejam precisamente quais
|
||||
mudanças significativas foram realizadas entre cada versão publicada.
|
||||
|
||||
### Por quê eu deveria me importar?
|
||||
### Por que eu deveria me importar?
|
||||
|
||||
Porque softwares são feitos para pessoas. Se você não liga, por quê está
|
||||
Porque softwares são feitos para pessoas. Se você não liga, por que está
|
||||
contribuindo com projetos *open source*? Certamente deve haver um fundo de
|
||||
carinho em algum lugar dessa sua cabecinha.
|
||||
|
||||
Eu [conversei com Adam Stacoviak e Jerod Santo no podcast do The
|
||||
Changelog][thechangelog] (faz sentido, hein?) sobre por quê mantenedores e
|
||||
contribuidores *open source* devem se importar, e as motivações por trás desse
|
||||
projeto. Se você tem o tempo (1:06), é um bom programa.
|
||||
Changelog][thechangelog] (faz sentido, hein?) sobre por que mantenedores e
|
||||
contribuidores *open source* devem se importar e as motivações por trás desse
|
||||
projeto. Se você tem tempo (1:06), é um bom programa.
|
||||
|
||||
### O que faz um *changelog* ser bom?
|
||||
|
||||
@ -46,7 +46,7 @@ version: 0.3.0
|
||||
- É feito para seres humanos, não máquinas, então legibilidade é crucial.
|
||||
- É fácil de referenciar (*linkar*) qualquer seção (por isso Markdown ao
|
||||
invés de puro texto).
|
||||
- Uma sub-seção por versão.
|
||||
- Uma subseção por versão.
|
||||
- Lista as versões publicadas em ordem cronológica decrescente (mais novo em
|
||||
cima).
|
||||
- Usa todas as datas no formato `AAAA-MM-DD`. (Exemplo: `2012-06-02` para
|
||||
@ -79,7 +79,7 @@ version: 0.3.0
|
||||
|
||||
### O que faz os unicórnios chorarem?
|
||||
|
||||
Tudo bem...vamos lá.
|
||||
Tudo bem... vamos lá.
|
||||
|
||||
- **Despejar logs de commits.** Simplesmente não faça isso, você não está
|
||||
ajudando ninguém.
|
||||
@ -94,8 +94,8 @@ version: 0.3.0
|
||||
ISO](http://www.iso.org/iso/home/standards/iso8601.htm). Portanto, é o
|
||||
formato recomendado para *changelogs*.
|
||||
|
||||
Tem mais. Ajude me a coletar essas lágrimas de unicórnio [abrindo uma
|
||||
issue][issues] ou um pull request.
|
||||
Tem mais. Ajude-me a coletar essas lágrimas de unicórnio [abrindo uma
|
||||
issue][issues] ou um *pull request*.
|
||||
|
||||
### Existe um padrão de formato de *changelog*?
|
||||
|
||||
@ -107,7 +107,7 @@ version: 0.3.0
|
||||
para lidar.
|
||||
|
||||
Este projeto [contém o que eu espero se tornar um melhor padrão de arquivo
|
||||
CHANGELOG][CHANGELOG] para todos projetos *open source*. Eu não acredito que o status quo
|
||||
CHANGELOG][CHANGELOG] para todos os projetos *open source*. Eu não acredito que o status quo
|
||||
seja bom o suficiente, e acho que, como uma comunidade, nós podemos encontrar novas convenções
|
||||
se tentarmos extrair boas práticas de projetos de software reais. Por favor, dê uma olhada e
|
||||
lembre-se de que [discussões e sugestões de melhorias são bem-vindas][issues]!
|
||||
@ -122,11 +122,11 @@ version: 0.3.0
|
||||
|
||||
É uma bagunça. Todos esses nomes só dificultam encontrar o *changelog*.
|
||||
|
||||
### Por quê as pessoas não podem simplesmente utilizar `git log`?
|
||||
### Por que as pessoas não podem simplesmente utilizar `git log`?
|
||||
|
||||
Porque diffs de logs são cheios de ruído — por natureza. Eles não serviriam como
|
||||
um changelog mesmo em um projeto hipotético executado por humanos perfeitos, que
|
||||
nunca erraram uma letra, esqueceram de *commit*'ar um arquivo, nunca perderam nenhuma
|
||||
nunca erraram uma letra, esqueceram de *commit'ar* um arquivo, nunca perderam nenhuma
|
||||
parte de um *refactoring*. O propósito de um *commit* é documentar um passo atômico no
|
||||
processo pelo qual o código evolui de um estado a outro. O propósito de um *changelog*
|
||||
é documentar as diferenças relevantes entre esses estados.
|
||||
@ -136,7 +136,7 @@ version: 0.3.0
|
||||
|
||||
### Podem os *changelogs* ser automaticamente interpretados?
|
||||
|
||||
É difícil, por que as pessoas seguem formatos e nomes de arquivos
|
||||
É difícil, porque as pessoas seguem formatos e nomes de arquivos
|
||||
radicalmente diferentes.
|
||||
|
||||
[Vandamme][vandamme] é uma gem criada pelo time [Gemnasium][gemnasium] que
|
||||
@ -155,7 +155,7 @@ version: 0.3.0
|
||||
qualquer um que pretenda utilizar ou contribuir com o projeto, assim como os [as
|
||||
badges de projeto *open source*][shields].
|
||||
|
||||
Quando eu me refiro a "*changelog*", eu estou falando sobre a função deste
|
||||
Quando eu me refiro a "*changelog*", eu estou falando sobre a função desse
|
||||
arquivo: listar mudanças.
|
||||
|
||||
### E sobre as publicações removidas?
|
||||
|
Loading…
x
Reference in New Issue
Block a user