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='da'> <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='Du skal ikke lade dine venner smide git logs i changelogs.' name='description'> <meta content='https://www.facebook.com/olivier.lacan.5' property='og:article:publisher'> <meta content='Hold en changelog' property='og:title'> <meta content='article' property='og:type'> <meta content='https://keepachangelog.com/da/1.1.0/' property='og:url'> <meta content='Du skal ikke lade dine venner smide git logs i 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/da/1.1.0/' rel='canonical'> <title>Hold en 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/application-d3e51c0c.css" rel="stylesheet"/> <script src="/assets/javascripts/all-466c2b8a.js" defer="defer"></script> </head> <body> <article> <header> <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' selected 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' 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> <img src="/assets/images/keep-a-changelog-mark-f8b06a42.svg" width="130" height="100" class="mark" alt=""/> </header> <div class='main' role='main'> <div class='header'> <div class='title'> <h1>Hold en changelog</h1> <h2>Du skal ikke lade dine venner smide git logs i changelogs.</h2> </div> <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">Version <strong>1.1.0</strong> </a><pre class='changelog' lang='en'># 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> </div> <div class='answers'> <h3 id='what'> <a aria_hidden='true' class='anchor' href='#what'></a> Hvad er en changelog? </h3> <p> En changelog er en fil, der indeholder en organiseret, kronologisk sorteret liste af bemærkelsesværdige ændringer for hver version af et projekt. </p> <h3 id='why'> <a aria_hidden='true' class='anchor' href='#why'></a> Hvorfor have en changelog? </h3> <p> For at gøre det nemmere for brugere og bidragsydere at se præcist hvilke bemærkelsesværdige ændringer, der er lavet mellem hver udgivelse eller version af et projekt. </p> <h3 id='who'> <a aria_hidden='true' class='anchor' href='#who'></a> Hvem skal bruge en changelog? </h3> <p> Det skal folk. Om det er forbrugere eller udviklere, er slutbrugere mennesker, der bekymrer sig om, hvad der er i et stykke software. Når softwaren ændrer sig, vil folk gerne vide hvad, og hvordan. </p> </div> <div class='good-practices'> <h3 id='how'> <a aria_hidden='true' class='anchor' href='#how'></a> Hvordan laver jeg en god changelog? </h3> <h4 id='principles'> <a aria_hidden='true' class='anchor' href='#principles'></a> Retningslinjer </h4> <ul> <li> Changelogs er til <em>for mennesker</em>, ikke maskiner. </li> <li> Der skal være et indlæg for hver eneste version. </li> <li> Ens typer af ændringer skal grupperes. </li> <li> Versioner og sektioner skal være link-bare. </li> <li> Den seneste version står først. </li> <li> Udgivelsesdatoen for hver version vises. </li> <li> Nævn hvorvidt du følger <a href="https://semver.org/">Semantisk Versionering</a>. </li> </ul> <a aria_hidden='true' class='anchor' href='#types'></a> <h4 id='types'>Ændringstyper</h4> <ul> <li> <code>Tilføjet (Added)</code> til nye funktioner. </li> <li> <code>Ændret (Dhanged)</code> til rettelser i eksisterende funktionalitet. </li> <li> <code>Udfaset (Deprecated)</code> til funktioner, der fjernes snart. </li> <li> <code>Fjernet (Removed)</code> til fjernede funktioner. </li> <li> <code>Rettet (Fixed)</code> til fejlrettelser. </li> <li> <code>Sikkerhed (Security)</code> i tilfælde af sårbarheder. </li> </ul> </div> <div class='effort'> <h3 id='effort'> <a aria_hidden='true' class='anchor' href='#effort'></a> Hvordan kan jeg reducere indsatsen ved at opretholde en changelog? </h3> <p> Hav en <code>Unreleased</code> sektion i toppen til kommende rettelser. </p> <p>Dette tjener to formål:</p> <ul> <li> Folk kan se, hvilke rettelser de kan forvente i den kommende udgivelse </li> <li> Ved udgivelsen kan du flytte <code>Unreleased</code> sektionens rettelser ind i en ny versionssektion. </li> </ul> </div> <div class='bad-practices'> <h3 id='bad-practices'> <a aria_hidden='true' class='anchor' href='#bad-practices'></a> Kan changelogs være dårlige? </h3> <p>Ja. Her er et par måder, de kan være mindre brugbare.</p> <h4 id='log-diffs'> <a aria_hidden='true' class='anchor' href='#log-diffs'></a> Commit log diffs </h4> <p> At bruge commit log differenser som changelog er en dårlig idé: De er fyldt med støj. Ting som merge-commits, commits med obskure titler, dokumentationsrettelser osv. </p> <p> Formålet med et commit er at dokumentere et trin i udviklingen af kildekoden. Nogle projekter rydder op i deres commits, andre gør ikke. </p> <p> Formålet med en changelog-indlæg er at dokumentere de bemærkelsesværdige forskelle, ofte fordelt over flere commits, for at formidle dem klart til slutbrugerene. </p> <h4 id='ignoring-deprecations'> <a aria_hidden='true' class='anchor' href='#ignoring-deprecations'></a> At ignorere udfasninger </h4> <p> Når folk opgraderer fra én version til en anden, skal det være helt tydeligt, hvorvidt noget vil gå i stykker. Det skal være muligt at opgradere til en version, der opsummerer udfasninger, fjerner gamle udfasniner, og opgradere til dén version, hvor udfasningerne bliver til oprydninger. </p> <p> Hvis du ikke gør andet, så notér udfasninger, fjernede funktioner og andre ødelæggende ændringer. </p> <h4 id='confusing-dates'> <a aria_hidden='true' class='anchor' href='#confusing-dates'></a> Forvirrende datoer </h4> <p> Regionale dataformater er varierende i hele verden, og det er ofte besværligt at finde et læsbart datoformat, der føles intuitivt for alle Fordelen ved datoer formatteret som <code>2017-07-17</code> er at de følger rækkefølgen for største til mindste enhed: år, måned og dag. Dette format overlapper heller ikke på en tvetydig måde med andre datoformater, der ombytter måneden og daten. Af disse årsager, og det faktum at dette datoformat er en <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO standard</a>, er dette det anbefalede datoformat for changelog-indlæg. </p> <h4 id='inconsistent-changes'> <a aria_hidden='true' class='anchor' href='#inconsistent-changes'></a> Ukonsistente rettelser </h4> <p> En changelog, der kun nævner nogle af ændringerne, kan være lige så farlig som ikke at have en changelog. Mens mange af ændringerne måske ikke er relevante - for eksempel er det ikke være nødvendigt at notere, at vi har fjernet et enkelt mellemrum - bør væsentlige ændringer være nævnt i changeloggen. Ved inkonsekvent at anvende ændringer, kan dine brugere fejlagtigt tro, at changelog er den eneste kilde til sandhed. Det bør den være. Med store magtbeføjelser følger store forpligtigelser. At have en god changelog er at have en konsekvent opdateret changelog. </p> <aside> Der er mere. Hjælp mig med at samle disse fælder ved at <a href="https://github.com/olivierlacan/keep-a-changelog/issues">åbne et issue</a> eller et pull-request. </aside> </div> <div class='frequently-asked-questions'> <h3 id='frequently-asked-questions'> <a aria_hidden='true' class='anchor' href='#frequently-asked-questions'></a> Ofte stillede spørgsmål </h3> <h4 id='standard'> <a aria_hidden='true' class='anchor' href='#standard'></a> Er der et standard changelog-format? </h4> <p> Ikke rigtig. Der er <a href="https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs">GNU changelog style guide</a>, eller <a href="https://www.gnu.org/prep/standards/html_node/NEWS-File.html#NEWS-File">two-paragraph-long GNU NEWS file</a>. De er begge utilstrækkelige eller uhensigtsmæssige. </p> <p> Dette projekt sigter efter at være <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">en bedre changelog konvention.</a> Det kommer af at observere god praksis i opensource-verdenen og samle disse. </p> <p> Konstruktiv kritik diskussion og forbedringsforslag <a href="https://github.com/olivierlacan/keep-a-changelog/issues">er velkomne.</a> </p> <h4 id='filename'> <a aria_hidden='true' class='anchor' href='#filename'></a> Hvad skal changelog-filen hedde? </h4> <p> Kald den <code>CHANGELOG.md</code>. Nogle projekter bruger <code>HISTORY</code>, <code>NEWS</code> eller <code>RELEASES</code>. </p> <p> Selvom det er nemt at mene, at navnet på changelog-filen er irrelevant, hvorfor så gøre det sværere for dine slugbrugere at finde bemærkelsesværdige ændringer? </p> <h4 id='github-releases'> <a aria_hidden='true' class='anchor' href='#github-releases'></a> Hvad med GitHub Releases? </h4> <p> Det er et godt initiativ. <a href="https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository">Releases</a> kan bruges til at gøre simple git tags (for eksempel, et tag <code>v1.0.0</code>) til fyldige udgivelsesnoter ved manuelt at tilføje noter til disse eller bruge en annoteret git-tag-besked som udgivelsesnoter. </p> <p> GitHub Releases laver en ikke-flytbar changelog, der kun kan vises til bruger i konteksten af GitHub. Det er muligt at få dem til at ligne Hold en changelog-formatet, men det har en tendens til at være lidt mere kompliceret. </p> <p> Den nuværende version af GitHub releases er, diskutérbart, ikke særligt synlig for slutbrugere, ikke lig de typiske kapitaliserede filer (<code>README</code>, <code>CONTRIBUTING</code>, osv.). Et andet mindre problem, er at interfacet ikke tilbyder links til commit logs mellem hvert release. </p> <h4 id='automatic'> <a aria_hidden='true' class='anchor' href='#automatic'></a> Kan changelogs læses og fortolkes automatisk? </h4> <p> Det er besværligt, fordi folk følger vidt forskellige formater og filnavne. </p> <p> <a href="https://github.com/tech-angels/vandamme/">Vandamme</a> er en Ruby gem lavet af holdet bag Gemnasium, som læser og fortolker mange (men ikke alle) open source projekters changelogs. </p> <h4 id='yanked'> <a aria_hidden='true' class='anchor' href='#yanked'></a> Hvad med tilbagetrukkede udgivelser? </h4> <p> Tilbagetrukkede udgivelser er versioner, der er blevet trukket tilbage på grund af en seriøs fejl eller sikkerhedsbrist. Ofte vises disse versioner slet ikke i changelogs. Det bør de. Dette er hvordan du bør vise dem: </p> <p><code>## 0.0.5 - 2014-12-13 [YANKED]</code></p> <p> Notationen <code>[YANKED]</code>, er højlydt af en årsag: Det er vigtig information for folk. Siden den er pakket ind i klammer, er den nemmere at fortolke og læse systematiseret. </p> <h4 id='rewrite'> <a aria_hidden='true' class='anchor' href='#rewrite'></a> Bør man nogensinde omskrive en changelog? </h4> <p> Klart! Der er altid gode grunde til at forbedre en changelog. Jeg åbner jævnligt pull-requests, der tilføjer manglende releases til open source projekter uden en vedligeholdt changelog. </p> <p> Det er også muligt, at du vil opdage at du har glemt at addressere en ødelæggende rettelse i noterne for en version. Det er selvfølgelig vigtigt at du opdaterer en changelog i disse tilfælde. </p> <h4 id='contribute'> <a aria_hidden='true' class='anchor' href='#contribute'></a> Hvordan kan jeg hjælpe til? </h4> <p> Dette dokument er ikke <strong>sandheden</strong>; det er min velovervejede mening sammen med information og eksempler jeg har samlet. </p> <p> Det er fordi, jeg gerne vil have at vores fællesskab når en konsensus. Jeg mener at diskussionen er lige så vigtig som slutresultatet. </p> <p> Så, <strong><a href="https://github.com/olivierlacan/keep-a-changelog">vær med!</a></strong> </p> </div> <div class='press'> <h3>Samtaler</h3> <p> Jeg var med i <a href="https://changelog.com/podcast/127">The Changelog podcast</a> for at snakke om, hvorfor vedligeholdere og bidragsydere bør bekymre sig om changelogs og også om motivationen bag dette projekt. </p> </div> <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> |