mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-08-25 03:38:13 +02:00
276 lines
24 KiB
HTML
276 lines
24 KiB
HTML
<!DOCTYPE html> <html lang='sk'> <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='Nenechaj kamarátov sypať git logy do changelogov.' name='description'> <meta content='https://www.facebook.com/olivier.lacan.5' property='og:article:publisher'> <meta content='Udržuj changelog' property='og:title'> <meta content='article' property='og:type'> <meta content='https://keepachangelog.com/sk/1.0.0/' property='og:url'> <meta content='Nenechaj kamarátov sypať git logy do changelogov.' 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/sk/1.0.0/' rel='canonical'> <title>Udržuj 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> <div class='last-version-notice'> The latest version (1.1.0) is not yet available in this language but <a href="/en/1.1.0">you can read it in English</a> for now and <a href="https://github.com/olivierlacan/keep-a-changelog/issues">help translate </a> it. </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' 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' selected 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>Udržuj changelog</h1> <h2>Nenechaj kamarátov sypať git logy do changelogov.</h2> </div> <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">Verzia <strong>1.0.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> Čo je to changelog? </h3> <p> Changelog je súbor obsahujúci organizovaný, chronologicky usporiadaný zoznam významných zmien pre každú verziu daného projektu. </p> <h3 id='why'> <a aria_hidden='true' class='anchor' href='#why'></a> Prečo udržiavať changelog? </h3> <p> Aby používatelia a prispievatelia presne vedeli, aké podstatné zmeny sa udiali medzi jednotlivými vydaniami (alebo verziami) projektu. </p> <h3 id='who'> <a aria_hidden='true' class='anchor' href='#who'></a> Kto potrebuje changelog? </h3> <p> Ľudia. Či už konzumenti, alebo vývojári, koncoví používatelia softvéru sú ľudské bytosti, ktorým záleží na tom, čo softvér obsahuje. Keď sa softvér zmení, ľudia chcú vedieť prečo a ako. </p> </div> <div class='good-practices'> <h3 id='how'> <a aria_hidden='true' class='anchor' href='#how'></a> Ako vytvorím dobrý changelog? </h3> <h4 id='principles'> <a aria_hidden='true' class='anchor' href='#principles'></a> Hlavné princípy </h4> <ul> <li> Changelogy sú <em>pre ľudí</em>, nie stroje. </li> <li> Changelog by mal obsahovať záznam pre každú jednu verziu. </li> <li> Rovnaké typy zmien by mali byť zoskupené. </li> <li> Mala by existovať možnosť odkazovať na jednotlivé verzie a sekcie. </li> <li> Posledná verzia je uvedená na prvom mieste. </li> <li> Pre každú verziu je uvedený dátum jej vydania. </li> <li> Uveď tiež, že sa držíš <a href="https://semver.org/">sémantického verziovania</a>. </li> </ul> <a aria_hidden='true' class='anchor' href='#types'></a> <h4 id='types'>Typy zmien</h4> <ul> <li> <code>Added</code> pre nové funkcie. </li> <li> <code>Changed</code> pre zmeny existujúcej funkcie. </li> <li> <code>Deprecated</code> pre funkcie, ktoré budú čoskoro odstránené. </li> <li> <code>Removed</code> pre odstránené funkcie. </li> <li> <code>Fixed</code> pre opravy chýb. </li> <li> <code>Security</code> v prípade bezpečnostných zraniteľností. </li> </ul> </div> <div class='effort'> <h3 id='effort'> <a aria_hidden='true' class='anchor' href='#effort'></a> Ako minimalizovať úsilie vynaložené na udržiavanie changelogu? </h3> <p> Udržuj <code>Unreleased</code> sekciu na začiatku changelogu pre nadchádzajúce zmeny. </p> <p>Má to dva dôvody:</p> <ul> <li> Ľudia môžu vidieť, aké zmeny môžu očakávať v ďalších vydaniach </li> <li> V čase vydávania novej verzie môžeš presunúť zmeny z <code>Unreleased</code> sekcie do sekcie novej verzie </li> </ul> </div> <div class='bad-practices'> <h3 id='bad-practices'> <a aria_hidden='true' class='anchor' href='#bad-practices'></a> Môžu byť changelogy zlé? </h3> <p>Áno. Tu je hneď niekoľko spôsobov, ako môžu byť neužitočné.</p> <h4 id='log-diffs'> <a aria_hidden='true' class='anchor' href='#log-diffs'></a> Diffy z commit logu </h4> <p> Použitie diffov z commit logu ako changelog nie je dobrý nápad: sú plné balastu. Veci ako merge commity, commity s nejasnými názvami, zmeny dokumentácie a pod. </p> <p> Účel commitu je dokumentovanie kroku v evolúcii zdrojového kódu. Niektoré projekty commity prečisťujú, iné nie. </p> <p> Účelom changelogu je dokumentovanie významných zmien, často naprieč viacerými commitmi, a jasne ich komunikovať koncovému používateľovi. </p> <h4 id='ignoring-deprecations'> <a aria_hidden='true' class='anchor' href='#ignoring-deprecations'></a> Ignorovanie oznámenia zastaralých funkcií </h4> <p> Keď používatelia prechádzajú na novšiu verziu, musí byť jasné, čo sa rozbije. Mala by pre nich existovať možnosť prejsť na verziu so zoznamom zastaralých funkcií, tieto funkcie odstrániť a následne prejsť na verziu, kde sú tieto zastaralé funkcie už odstránené. </p> <p> Ak už nič iné, tak aspoň uveď zastaralé, odstránené funkcie a všetky zmeny, ktoré môžu niečo rozbiť, do changelogu. </p> <h4 id='confusing-dates'> <a aria_hidden='true' class='anchor' href='#confusing-dates'></a> Mätúce dátumy </h4> <p> Regionálne formáty dátumov sa líšia naprieč svetom a často je zložité nájsť formát dátumu, ktorý by bol prívetivý a intuitívny pre všetkých používateľov. Výhodou dátumu vo formáte <code>2017-07-17</code> je poradie od najväčšej jednotky po najmenšiu: rok, mesiac, deň. Tento formát sa tiež neprekrýva s inými formátmi, ktoré zamieňajú pozíciu dňa a mesiaca. Kvôli týmto dôvodom spolu s faktom, že ide o <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO štandard</a>, je tento formát odporučený pre záznamy v changelogu. </p> <aside> Je toho však viac. Pomôž mi zozbierať tieto antivzory <a href="https://github.com/olivierlacan/keep-a-changelog/issues">otvorením issue</a> alebo pull requestom. </aside> </div> <div class='frequently-asked-questions'> <h3 id='frequently-asked-questions'> <a aria_hidden='true' class='anchor' href='#frequently-asked-questions'></a> Často kladené otázky </h3> <h4 id='standard'> <a aria_hidden='true' class='anchor' href='#standard'></a> Existuje štandardný formát pre changelog? </h4> <p> Nie. Existuje GNU príručka pre štýl changelogu alebo dvojodstavcová GNU "smernica" pre NEWS súbor. Obe sú však nevhodné či nedostatočné. </p> <p> Tento projekt sa snaží byť <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">lepšou konvenciou pre changelog.</a> Vychádza z pozorovania a zozbierania osvedčených postupov komunity okolo projektov s otvoreným zdrojovým kódom. </p> <p> Zdravá kritika, diskusia a návrhy na zlepšenie <a href="https://github.com/olivierlacan/keep-a-changelog/issues">sú vítané.</a> </p> <h4 id='filename'> <a aria_hidden='true' class='anchor' href='#filename'></a> Ako by mal byť súbor changelogu pomenovaný? </h4> <p> Nazvi ho <code>CHANGELOG.md</code>. Niektoré projekty používajú tiež <code>HISTORY</code>, <code>NEWS</code> alebo <code>RELEASES</code>. </p> <p> Je jednoduché myslieť si, že názov changelogu nie je taký dôležitý. Prečo však sťažovať koncovému používateľovi hľadanie významných zmien? </p> <h4 id='github-releases'> <a aria_hidden='true' class='anchor' href='#github-releases'></a> A čo GitHub Releases? </h4> <p> Je to skvelá iniciatíva. Služba <a href="https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository">Releases</a> môže byť použitá pre premenu git tagov (napríklad tagu <code>v1.0.0</code>) na bohaté poznámky k vydaniam manuálnym pridávaním týchto poznámok alebo získaním správ z anotovaných git tagov a vytvorením poznámok k vydaniu z nich. </p> <p> GitHub Releases vytvorí neprenosný changelog, ktorý môže byť zobrazený používateľom v rámci GitHubu. Je možné ich upraviť na veľmi podobný štýl, aký navrhuje projekt Udržuj changelog, tento postup však býva trochu zložitejší. </p> <p> Súčasná verzia GitHub Releases tiež nie je ľahko objaviteľná koncovým používateľom, na rozdiel od klasického súboru s názvom napísaným veľkými písmenami (<code>README</code>, <code>CONTRIBUTING</code> atď.). Ďalším menším problémom je, že v súčasnosti nepodporuje odkazy na commit logy medzi jednotlivými vydaniami. </p> <h4 id='automatic'> <a aria_hidden='true' class='anchor' href='#automatic'></a> Môžu byť changelogy automaticky parsované? </h4> <p> Je to zložité, pretože ľudia používajú rôzne formáty a názvy súborov. </p> <p> <a href="https://github.com/tech-angels/vandamme/">Vandamme</a> je Ruby gem vytvorený tímom Gemnasium, ktorý parsuje mnohé (ale nie všetky) changelogy projektov s otvoreným zdrojovým kódom. </p> <h4 id='yanked'> <a aria_hidden='true' class='anchor' href='#yanked'></a> A čo spätne stiahnuté vydania? </h4> <p> Stiahnuté vydania sú verzie, ktoré museli byť neskôr spätne odobraté kvôli vážnej chybe alebo bezpečnostným rizikám. Tieto verzie sa často v changelogu ani neobjavia. Ale mali by sa. Zobrazovať by sa mali takto: </p> <p><code>## [0.0.5] - 2014-12-13 [YANKED]</code></p> <p> Tag <code>[YANKED]</code> kričí naschvál. Je dôležité, aby si ho ľudia všimli. Keďže je uzavretý zátvorkami, je tiež jednoduchšie ho programovo parsovať. </p> <h4 id='rewrite'> <a aria_hidden='true' class='anchor' href='#rewrite'></a> Mal by sa changelog niekedy prepisovať? </h4> <p> Samozrejme. Vždy sa nájde dobrý dôvod na vylepšenie changelogu. Sám často otváram pull requesty pre pridanie chýbajúceho vydania projektov s otvoreným kódom a neudržiavaným changelogom. </p> <p> Tiež môže nastať situácia, že v poznámkach k vydaniu určitej verzie sa zabudla spomenúť podstatná zmena. V takom prípade je samozrejme dôležité tento changelog aktualizovať. </p> <h4 id='contribute'> <a aria_hidden='true' class='anchor' href='#contribute'></a> Ako môžem prispieť? </h4> <p> Tento dokument nie je úplná <strong>pravda</strong>; je mojím starostlivo zváženým názorom spolu s informáciami a príkladmi, ktoré som zozbieral. </p> <p> Je tomu tak preto, aby komunita dosiahla určitý konsenzus. Verím, že diskusia je rovnako dôležitá ako samotný výsledok. </p> <p> Takže, prosím, <strong><a href="https://github.com/olivierlacan/keep-a-changelog">prilož ruku k dielu</a></strong>. </p> </div> <div class='press'> <h3>Rozhovory</h3> <p> Zúčastnil som sa podcastu <a href="https://changelog.com/podcast/127">The Changelog</a>, kde sme sa rozprávali o tom, prečo by sa správci projektov a prispievatelia mali zaujímať o changelogy a tiež o motivácii za týmto projektom. </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> |