mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-08-22 18:28:16 +02:00
276 lines
24 KiB
HTML
276 lines
24 KiB
HTML
<!DOCTYPE html> <html lang='pt-BR'> <head> <meta charset='utf-8'> <meta content='IE=edge' http-equiv='X-UA-Compatible'> <meta content='width=device-width, initial-scale=1.0' name='viewport'> <meta content='Não deixe seus amigos despejarem logs de commits em CHANGELOGs' name='description'> <meta content='https://www.facebook.com/olivier.lacan.5' property='og:article:publisher'> <meta content='Mantenha um CHANGELOG' property='og:title'> <meta content='article' property='og:type'> <meta content='https://keepachangelog.com/pt-BR/0.3.0/' property='og:url'> <meta content='Não deixe seus amigos despejarem logs de commits em CHANGELOGs' property='og:description'> <meta content='https://keepachangelog.com/assets/images/keep-a-changelog-opengraph-851f2d20.png' property='og:image'> <link href='/assets/images/favicon.ico' rel='shortcut icon' type='image/x-icon'> <link href='https://keepachangelog.com/pt-BR/0.3.0/' rel='canonical'> <title>Mantenha um CHANGELOG</title> <link href='https://fonts.googleapis.com' rel='preconnect'> <link crossorigin='true' href='https://fonts.gstatic.com' rel='preconnect'> <link href="//fonts.googleapis.com/css?family=Muli:400,700&display=swap" rel="stylesheet"/> <link href="//fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap" rel="stylesheet"/> <link href="/assets/stylesheets/legacy-8d0d490e.css" rel="stylesheet"/> <script src="/assets/javascripts/all-466c2b8a.js" defer="defer"></script> </head> <body> <article> <header> <div class='newer'> There is a newer version available: <a href="/pt-BR/1.1.0">Português do Brasil 1.1.0</a> </div> <nav class='locales' role='navigation'> <label for='language-select' title='Pick one of the 28 translations'>Languages (28):</label> <select id='language-select' name='language'> <option label='1.0.0 العربية' value='ar'> 1.0.0 العربية </option> <option label='1.1.0 Čeština' value='cs'> 1.1.0 Čeština </option> <option label='1.1.0 Dansk' value='da'> 1.1.0 Dansk </option> <option label='1.1.0 Deutsch' value='de'> 1.1.0 Deutsch </option> <option label='1.1.0 English' value='en'> 1.1.0 English </option> <option label='1.1.0 Español' value='es-ES'> 1.1.0 Español </option> <option label='1.1.0 Français' value='fr'> 1.1.0 Français </option> <option label='1.0.0 Hrvatski' value='hr'> 1.0.0 Hrvatski </option> <option label='1.0.0 Indonesia' value='id-ID'> 1.0.0 Indonesia </option> <option label='1.1.0 Italiano' value='it-IT'> 1.1.0 Italiano </option> <option label='1.1.0 日本語' value='ja'> 1.1.0 日本語 </option> <option label='1.1.0 Norsk (Bokmål)' value='nb'> 1.1.0 Norsk (Bokmål) </option> <option label='1.1.0 Nederlands' value='nl'> 1.1.0 Nederlands </option> <option label='1.1.0 polski' value='pl'> 1.1.0 polski </option> <option label='1.1.0 Português do Brasil' selected value='pt-BR'> 1.1.0 Português do Brasil </option> <option label='1.1.0 română' value='ro'> 1.1.0 română </option> <option label='1.1.0 Pyccкий' value='ru'> 1.1.0 Pyccкий </option> <option label='1.0.0 Slovenčina' value='sk'> 1.0.0 Slovenčina </option> <option label='1.0.0 ქართული' value='ka'> 1.0.0 ქართული </option> <option label='1.1.0 Slovenščina' value='sl'> 1.1.0 Slovenščina </option> <option label='1.0.0 Srpski' value='sr'> 1.0.0 Srpski </option> <option label='1.1.0 Svenska' value='sv'> 1.1.0 Svenska </option> <option label='1.1.0 Türkçe' value='tr-TR'> 1.1.0 Türkçe </option> <option label='1.1.0 Українська' value='uk'> 1.1.0 Українська </option> <option label='1.1.0 简体中文' value='zh-CN'> 1.1.0 简体中文 </option> <option label='1.1.0 正體中文' value='zh-TW'> 1.1.0 正體中文 </option> <option label='1.0.0 한국어' value='ko'> 1.0.0 한국어 </option> <option label='1.1.0 فارسی' value='fa'> 1.1.0 فارسی </option> </select> </nav> </header> <div class='main' role='main'> <h1>Mantenha um CHANGELOG</h1> <h2>Não deixe seus amigos despejarem logs de commits em CHANGELOGs</h2> Version <strong>0.3.0</strong> <h3>O que é um <em>changelog</em>?</h3> <p>Um <em>changelog</em> é um arquivo que contém uma lista selecionada, ordenada cronologicamente, de mudanças significativas para cada versão de um projeto <em>open source</em>.</p> <pre class="changelog"># Changelog
|
||
|
||
All notable changes to this project will be documented in this file.
|
||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||
|
||
## [Unreleased]
|
||
|
||
### Added
|
||
|
||
- v1.1 Brazilian Portuguese translation.
|
||
- v1.1 German Translation
|
||
- v1.1 Spanish translation.
|
||
- v1.1 Italian translation.
|
||
- v1.1 Polish translation.
|
||
- v1.1 Ukrainian translation.
|
||
|
||
### Changed
|
||
|
||
- Use frontmatter title & description in each language version template
|
||
- Replace broken OpenGraph image with an appropriately-sized Keep a Changelog
|
||
image that will render properly (although in English for all languages)
|
||
- Fix OpenGraph title & description for all languages so the title and
|
||
description when links are shared are language-appropriate
|
||
|
||
### Removed
|
||
|
||
- Trademark sign previously shown after the project description in version
|
||
0.3.0
|
||
|
||
## [1.1.1] - 2023-03-05
|
||
|
||
### Added
|
||
|
||
- Arabic translation (#444).
|
||
- v1.1 French translation.
|
||
- v1.1 Dutch translation (#371).
|
||
- v1.1 Russian translation (#410).
|
||
- v1.1 Japanese translation (#363).
|
||
- v1.1 Norwegian Bokmål translation (#383).
|
||
- v1.1 "Inconsistent Changes" Turkish translation (#347).
|
||
- Default to most recent versions available for each languages.
|
||
- Display count of available translations (26 to date!).
|
||
- Centralize all links into `/data/links.json` so they can be updated easily.
|
||
|
||
### Fixed
|
||
|
||
- Improve French translation (#377).
|
||
- Improve id-ID translation (#416).
|
||
- Improve Persian translation (#457).
|
||
- Improve Russian translation (#408).
|
||
- Improve Swedish title (#419).
|
||
- Improve zh-CN translation (#359).
|
||
- Improve French translation (#357).
|
||
- Improve zh-TW translation (#360, #355).
|
||
- Improve Spanish (es-ES) transltion (#362).
|
||
- Foldout menu in Dutch translation (#371).
|
||
- Missing periods at the end of each change (#451).
|
||
- Fix missing logo in 1.1 pages.
|
||
- Display notice when translation isn't for most recent version.
|
||
- Various broken links, page versions, and indentations.
|
||
|
||
### Changed
|
||
|
||
- Upgrade dependencies: Ruby 3.2.1, Middleman, etc.
|
||
|
||
### Removed
|
||
|
||
- Unused normalize.css file.
|
||
- Identical links assigned in each translation file.
|
||
- Duplicate index file for the english version.
|
||
|
||
## [1.1.0] - 2019-02-15
|
||
|
||
### Added
|
||
|
||
- Danish translation (#297).
|
||
- Georgian translation from (#337).
|
||
- Changelog inconsistency section in Bad Practices.
|
||
|
||
### Fixed
|
||
|
||
- Italian translation (#332).
|
||
- Indonesian translation (#336).
|
||
|
||
## [1.0.0] - 2017-06-20
|
||
|
||
### Added
|
||
|
||
- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
|
||
- Version navigation.
|
||
- Links to latest released version in previous versions.
|
||
- "Why keep a changelog?" section.
|
||
- "Who needs a changelog?" section.
|
||
- "How do I make a changelog?" section.
|
||
- "Frequently Asked Questions" section.
|
||
- New "Guiding Principles" sub-section to "How do I make a changelog?".
|
||
- Simplified and Traditional Chinese translations from [@tianshuo](https://github.com/tianshuo).
|
||
- German translation from [@mpbzh](https://github.com/mpbzh) & [@Art4](https://github.com/Art4).
|
||
- Italian translation from [@azkidenz](https://github.com/azkidenz).
|
||
- Swedish translation from [@magol](https://github.com/magol).
|
||
- Turkish translation from [@emreerkan](https://github.com/emreerkan).
|
||
- French translation from [@zapashcanon](https://github.com/zapashcanon).
|
||
- Brazilian Portuguese translation from [@Webysther](https://github.com/Webysther).
|
||
- Polish translation from [@amielucha](https://github.com/amielucha) & [@m-aciek](https://github.com/m-aciek).
|
||
- Russian translation from [@aishek](https://github.com/aishek).
|
||
- Czech translation from [@h4vry](https://github.com/h4vry).
|
||
- Slovak translation from [@jkostolansky](https://github.com/jkostolansky).
|
||
- Korean translation from [@pierceh89](https://github.com/pierceh89).
|
||
- Croatian translation from [@porx](https://github.com/porx).
|
||
- Persian translation from [@Hameds](https://github.com/Hameds).
|
||
- Ukrainian translation from [@osadchyi-s](https://github.com/osadchyi-s).
|
||
|
||
### Changed
|
||
|
||
- Start using "changelog" over "change log" since it's the common usage.
|
||
- Start versioning based on the current English version at 0.3.0 to help
|
||
translation authors keep things up-to-date.
|
||
- Rewrite "What makes unicorns cry?" section.
|
||
- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal
|
||
scenario.
|
||
- Improve "Commit log diffs" sub-section to further argument against
|
||
them.
|
||
- Merge "Why can’t people just use a git log diff?" with "Commit log
|
||
diffs".
|
||
- Fix typos in Simplified Chinese and Traditional Chinese translations.
|
||
- Fix typos in Brazilian Portuguese translation.
|
||
- Fix typos in Turkish translation.
|
||
- Fix typos in Czech translation.
|
||
- Fix typos in Swedish translation.
|
||
- Improve phrasing in French translation.
|
||
- Fix phrasing and spelling in German translation.
|
||
|
||
### Removed
|
||
|
||
- Section about "changelog" vs "CHANGELOG".
|
||
|
||
## [0.3.0] - 2015-12-03
|
||
|
||
### Added
|
||
|
||
- RU translation from [@aishek](https://github.com/aishek).
|
||
- pt-BR translation from [@tallesl](https://github.com/tallesl).
|
||
- es-ES translation from [@ZeliosAriex](https://github.com/ZeliosAriex).
|
||
|
||
## [0.2.0] - 2015-10-06
|
||
|
||
### Changed
|
||
|
||
- Remove exclusionary mentions of "open source" since this project can
|
||
benefit both "open" and "closed" source projects equally.
|
||
|
||
## [0.1.0] - 2015-10-06
|
||
|
||
### Added
|
||
|
||
- Answer "Should you ever rewrite a change log?".
|
||
|
||
### Changed
|
||
|
||
- Improve argument against commit logs.
|
||
- Start following [SemVer](https://semver.org) properly.
|
||
|
||
## [0.0.8] - 2015-02-17
|
||
|
||
### Changed
|
||
|
||
- Update year to match in every README example.
|
||
- Reluctantly stop making fun of Brits only, since most of the world
|
||
writes dates in a strange way.
|
||
|
||
### Fixed
|
||
|
||
- Fix typos in recent README changes.
|
||
- Update outdated unreleased diff link.
|
||
|
||
## [0.0.7] - 2015-02-16
|
||
|
||
### Added
|
||
|
||
- Link, and make it obvious that date format is ISO 8601.
|
||
|
||
### Changed
|
||
|
||
- Clarified the section on "Is there a standard change log format?".
|
||
|
||
### Fixed
|
||
|
||
- Fix Markdown links to tag comparison URL with footnote-style links.
|
||
|
||
## [0.0.6] - 2014-12-12
|
||
|
||
### Added
|
||
|
||
- README section on "yanked" releases.
|
||
|
||
## [0.0.5] - 2014-08-09
|
||
|
||
### Added
|
||
|
||
- Markdown links to version tags on release headings.
|
||
- Unreleased section to gather unreleased changes and encourage note
|
||
keeping prior to releases.
|
||
|
||
## [0.0.4] - 2014-08-09
|
||
|
||
### Added
|
||
|
||
- Better explanation of the difference between the file ("CHANGELOG")
|
||
and its function "the change log".
|
||
|
||
### Changed
|
||
|
||
- Refer to a "change log" instead of a "CHANGELOG" throughout the site
|
||
to differentiate between the file and the purpose of the file — the
|
||
logging of changes.
|
||
|
||
### Removed
|
||
|
||
- Remove empty sections from CHANGELOG, they occupy too much space and
|
||
create too much noise in the file. People will have to assume that the
|
||
missing sections were intentionally left out because they contained no
|
||
notable changes.
|
||
|
||
## [0.0.3] - 2014-08-09
|
||
|
||
### Added
|
||
|
||
- "Why should I care?" section mentioning The Changelog podcast.
|
||
|
||
## [0.0.2] - 2014-07-10
|
||
|
||
### Added
|
||
|
||
- Explanation of the recommended reverse chronological release ordering.
|
||
|
||
## [0.0.1] - 2014-05-31
|
||
|
||
### Added
|
||
|
||
- This CHANGELOG file to hopefully serve as an evolving example of a
|
||
standardized open source project CHANGELOG.
|
||
- CNAME file to enable GitHub Pages custom domain.
|
||
- README now contains answers to common questions about CHANGELOGs.
|
||
- Good examples and basic guidelines, including proper date formatting.
|
||
- Counter-examples: "What makes unicorns cry?".
|
||
|
||
[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.1.1...HEAD
|
||
[1.1.1]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.1.0...v1.1.1
|
||
[1.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...v1.1.0
|
||
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
|
||
[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
|
||
[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
|
||
[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
|
||
[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
|
||
[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
|
||
[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
|
||
[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
|
||
[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
|
||
[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
|
||
[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
|
||
[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1
|
||
</pre> <h3>Para que serve um <em>changelog</em>?</h3> <p>Para facilitar que usuários e contribuidores vejam precisamente quais mudanças significativas foram realizadas entre cada versão publicada.</p> <h3>Por que eu deveria me importar?</h3> <p>Porque softwares são feitos para pessoas. Se você não liga, por que está contribuindo com projetos <em>open source</em>? Certamente deve haver um fundo de carinho em algum lugar desse seu amável cerebrinho.</p> <p>Eu <a href="https://changelog.com/podcast/127">conversei com Adam Stacoviak e Jerod Santo no podcast do The Changelog</a> (faz sentido, hein?) sobre por que mantenedores e contribuidores <em>open source</em> devem se importar e as motivações por trás desse projeto. Se você tem tempo (1:06), é um bom programa.</p> <h3>O que faz um <em>changelog</em> ser bom?</h3> <p>Que bom que perguntou.</p> <p>Um bom <em>changelog</em> se atém a esses princípios:</p> <ul> <li>É feito para seres humanos, não máquinas, então legibilidade é crucial.</li> <li>É fácil de referenciar (<em>linkar</em>) qualquer seção (por isso Markdown ao invés de puro texto).</li> <li>Uma subseção por versão.</li> <li>Lista as versões publicadas em ordem cronológica decrescente (mais novo em cima).</li> <li>Usa todas as datas no formato <code>AAAA-MM-DD</code>. (Exemplo: <code>2012-06-02</code> para <code>2 de Junho de 2012</code>.) É internacional, <a href="https://xkcd.com/1179/">sensato</a>, e independente de língua.</li> <li>Menciona explicitamente se o projeto segue o <a href="https://semver.org/">Versionamento Semântico</a>.</li> <li>Cada versão deve: <ul> <li>Listar sua data de publicação no formato acima.</li> <li>Agrupar mudanças descrevendo seus impactos no projeto, como segue:</li> <li><code>Added</code>/<code>Adicionado</code> para novas funcionalidades.</li> <li><code>Changed</code>/<code>Modificado</code> para mudanças em funcionalidades existentes.</li> <li><code>Deprecated</code>/<code>Obsoleto</code> para funcionalidades estáveis que foram removidas das próximas versões.</li> <li><code>Removed</code>/<code>Removido</code> para funcionalidades removidas desta versão.</li> <li><code>Fixed</code>/<code>Consertado</code> para qualquer correção de bug.</li> <li><code>Security</code>/<code>Segurança</code> para incentivar usuários a atualizarem em caso de vulnerabilidades.</li> </ul></li> </ul> <h3>Como eu posso minimizar o esforço exigido?</h3> <p>Mantenha sempre uma seção <code>"Unreleased"</code>`"A publicar"` no topo para manter o controle de quaisquer mudanças.</p> <p>Isso serve a dois propósitos:</p> <ul> <li>As pessoas podem ver quais mudanças elas podem esperar em publicações futuras.</li> <li>No momento da publicação, você apenas tem de mudar o <code>"Unreleased"</code>`"A publicar"<code>para o número de versão e adicionar um novo cabeçalho</code>"Unreleased"<code>\</code>"A publicar"` no topo.</li> </ul> <h3>O que faz os unicórnios chorarem?</h3> <p>Tudo bem... vamos lá.</p> <ul> <li><strong>Despejar logs de commits.</strong> Simplesmente não faça isso, você não está ajudando ninguém.</li> <li><strong>Não dar ênfase nas obsolências.</strong> Quando as pessoas atualizam de uma versão para outra, deve ser incrivelmente claro quando algo irá parar de funcionar.</li> <li><strong>Datas em formatos específicos de uma região.</strong> Nos Estados Unidos, as pessoas colocam o mês primeiro ("06-02-2012" para 2 de Junho de 2012, o que <em>não</em> faz sentido), enquanto muitos no resto do mundo escrevem em aspecto robótico "2 Junho 2012", e mesmo assim leem de forma diferente. "2012-06-02" funciona de maneira lógica do maior para o menor, não se confunde de maneira ambígua com outros formatos, e é um <a href="http://www.iso.org/iso/home/standards/iso8601.htm">padrão ISO</a>. Portanto, é o formato recomendado para <em>changelogs</em>.</li> </ul> <p>Tem mais. Ajude-me a coletar essas lágrimas de unicórnio <a href="https://github.com/olivierlacan/keep-a-changelog/issues">abrindo uma issue</a> ou um <em>pull request</em>.</p> <h3>Existe um padrão de formato de <em>changelog</em>?</h3> <p>Infelizmente, não. Calma. Eu sei que você está buscando furiosamente aquele link do guia GNU de estilo de <em>changelog</em>, ou o arquivo "guideline" de dois paragráfos do GNU NEWS. O estilo GNU é um bom começo mas, infelizmente, é ingênuo. Não há nada de errado em ser ingênuo mas, quando as pessoas precisam de orientação, raramente ajuda. Especialmente quando existem muitas situações excepcionais para lidar.</p> <p>Este projeto <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">contém o que eu espero se tornar um melhor padrão de arquivo CHANGELOG</a> para todos os projetos <em>open source</em>. 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 <a href="https://github.com/olivierlacan/keep-a-changelog/issues">discussões e sugestões de melhorias são bem-vindas</a>!</p> <h3>Qual deve ser o nome do arquivo <em>changelog</em>?</h3> <p>Bom, se você não notou no exemplo acima, <code>CHANGELOG.md</code> é a melhor convenção até agora.</p> <p>Alguns outros projetos também utilizam <code>HISTORY.txt</code>, <code>HISTORY.md</code>, <code>History.md</code>, <code>NEWS.txt</code>, <code>NEWS.md</code>, <code>News.txt</code>, <code>RELEASES.txt</code>, <code>RELEASE.md</code>, <code>releases.md</code>, etc.</p> <p>É uma bagunça. Todos esses nomes só dificultam encontrar o <em>changelog</em>.</p> <h3>Por que as pessoas não podem simplesmente utilizar <code>git log</code>?</h3> <p>Porque os logs do Git são cheios de ruído — por natureza. Eles não serviriam como um changelog adequado mesmo em um projeto hipotético executado por humanos perfeitos, que nunca erram uma letra, nunca esquecem de <em>commitar</em> arquivos, nunca cometem deslizes em uma refatoração. O propósito de um <em>commit</em> é documentar um passo atômico no processo pelo qual o código evolui de um estado a outro. O propósito de um <em>changelog</em> é documentar as diferenças relevantes entre esses estados.</p> <p>A mesma diferença que existe entre bons comentários e o código em si existe entre o <em>changelog</em> e o <em>commit log</em>: um descreve o <em>porquê</em>, o outro descreve o <em>como</em>.</p> <h3>Podem os <em>changelogs</em> ser automaticamente interpretados?</h3> <p>É difícil, porque as pessoas seguem formatos e nomes de arquivos radicalmente diferentes.</p> <p><a href="https://github.com/tech-angels/vandamme/">Vandamme</a> é uma gem criada pelo time <a href="https://gemnasium.com/">Gemnasium</a> que interpreta muitos (mas não todos) <em>changelogs</em> de projetos <em>open source</em>.</p> <h3>Por que você alterna entre as grafias "CHANGELOG" e "changelog"?</h3> <p>"CHANGELOG" é o nome do arquivo em si. É um pouco chamativo mas é uma convenção histórica seguida por muitos projetos <em>open source</em>. Outros exemplos similares de arquivo incluem <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/README.md"><code>README</code></a>, <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/LICENSE"><code>LICENSE</code></a>, e <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CONTRIBUTING.md"><code>CONTRIBUTING</code></a>.</p> <p>O nome em letras maiúsculas (o que em sistemas operacionais antigos faziam estes arquivos ficarem no topo da lista) é utilizado para chamar atenção. Por conterem importantes metadados do projeto, <em>changelogs</em> são úteis a qualquer um que pretenda utilizar ou contribuir com o projeto, da maneira equivalente às <a href="https://shields.io/">badges de projetos <em>open source</em></a>.</p> <p>Quando eu me refiro a "<em>changelog</em>", eu estou falando sobre a função desse arquivo: listar mudanças.</p> <h3>E sobre as publicações removidas?</h3> <p>Publicações removidas são versões que tiveram que ser removidas devido a um sério bug ou problema de segurança. Com frequência essas versões sequer aparecem em <em>changelogs</em>. Deveriam. É assim que você deve exibi-las:</p> <p><code>## [0.0.5] - 2014-12-13 [YANKED]</code></p> <p>A tag <code>[YANKED]</code>/<code>[REMOVIDA]</code> é chamativa por uma razão. É importante que as pessoas a notem. Além disso, já que é cercada por colchetes, é mais fácil detectá-la programaticamente.</p> <h3>Devemos alterar o <em>changelog</em> em alguma circunstância?</h3> <p>Claro. Sempre existem bons motivos para melhorar um <em>changelog</em>. Eu regularmente abro <em>pull requests</em> para adicionar versões faltantes em projetos <em>open source</em> com <em>changelogs</em> abandonados.</p> <p>Também é possível que você perceba que se esqueceu de registrar mudanças importantes nas notas de uma versão. É obviamente importante que você atualize seu <em>changelog</em> nesse caso.</p> <h3>Como eu posso contribuir?</h3> <p>Este documento não é a verdade; é minha cuidadosa opinião, junto com as informações e exemplos que reuni. Embora eu tenha providenciado um <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">CHANGELOG</a> no <a href="https://github.com/olivierlacan/keep-a-changelog">repositório no GitHub</a>, eu não criei de propósito uma lista clara de regras a serem seguidas (como o <a href="https://semver.org/">SemVer.org</a> faz, por exemplo).</p> <p>Fiz isso porque eu gostaria que nossa comunidade chegasse a um consenso. Eu acredito que a discussão é tão importante quanto o resultado final.</p> <p>Então, por favor, <a href="https://github.com/olivierlacan/keep-a-changelog">entre em campo</a>.</p> <footer class='footer clearfix' role='contentinfo'> <img src="/assets/images/keep-a-changelog-mark-f8b06a42.svg" width="30" height="30" class="mark" alt=""/> <p class='about'> This project is <a href="https://choosealicense.com/licenses/mit/">MIT Licensed</a> // <a href="https://github.com/olivierlacan/keep-a-changelog/">Created & maintained</a> by <a href="https://olivierlacan.com/">Olivier Lacan</a> <a href="https://ruby.social/@olivierlacan" rel="me" aria-label="Link to Olivier Lacan's Mastodon account"></a> // Designed by Tyler Fortune </p> </footer> </div> </article> </body> <script>
|
||
var _gauges = _gauges || [];
|
||
(function() {
|
||
var t = document.createElement('script');
|
||
t.type = 'text/javascript';
|
||
t.async = true;
|
||
t.id = 'gauges-tracker';
|
||
t.setAttribute('data-site-id', '5389808eeddd5b055a00440d');
|
||
t.src = '//secure.gaug.es/track.js';
|
||
var s = document.getElementsByTagName('script')[0];
|
||
s.parentNode.insertBefore(t, s);
|
||
})();
|
||
</script> </html> |