mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-08-22 18:28:16 +02:00
276 lines
23 KiB
HTML
276 lines
23 KiB
HTML
<!DOCTYPE html> <html lang='sl'> <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='Ne dopustite, da vaši prijatelji odlagajo git dnevnike v CHANGELOG™' name='description'> <meta content='https://www.facebook.com/olivier.lacan.5' property='og:article:publisher'> <meta content='Keep a Changelog' property='og:title'> <meta content='article' property='og:type'> <meta content='https://keepachangelog.com/sl/0.3.0/' property='og:url'> <meta content='Ne dopustite, da vaši prijatelji odlagajo git dnevnike v CHANGELOG™' 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/sl/0.3.0/' rel='canonical'> <title>Keep a 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="/sl/1.1.0">Slovenščina 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' 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' selected 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>Keep a Changelog</h1> <h2>Ne dopustite, da vaši prijatelji odlagajo git dnevnike v CHANGELOG™</h2> Version <strong>0.3.0</strong> <h3>Kaj je dnevnik sprememb?</h3> <p>Dnevnik sprememb je datoteka, ki vsebuje kuriran, kronološko urejen seznam opaznih sprememb za vsako verzijo projekta.</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>Kaj je smisel dnevnika sprememb?</h3> <p>Za poenostavitev, da uporabniki in prispevajoči sodelavci natančno vidijo, katere opazne spremembe so bile narejene med vsako izdajo (ali verzijo) projekta.</p> <h3>Zakaj se truditi?</h3> <p>Ker so programska orodja za ljudi. Če vam to ni pomembno, zakaj prispevate odprto kodnemu projektu? Zagotovo mora obstajati malenkost (hehe) skrbnosti nekje v vaši lepi glavi.</p> <p>Govorili smo z <a href="https://changelog.com/podcast/127">Adam-om Stacoviak-om in Jerod-om Santo na temo Changelog-a</a> (ustrezno, kajne?) podcast o tem zakaj bi se morali vzdrževalci in sodelavci, ki prispevajo, truditi in o motivaciji za tem projektom. Če imate na voljo nekaj časa (1:06), je odlično poslušanje.</p> <h3>Kaj naredi dnevnik sprememb odličen?</h3> <p>Veseli me, da ste vprašali.</p> <p>Dober dnevnik sprememb se drži teh načel:</p> <ul> <li>Je enostaven za ljudi, ne stroje, tako da je čitljivost ključnega pomena.</li> <li>Enostaven za povezavo kateri koli sekciji (torej Markdown pred golim besedilom).</li> <li>Ena pod-sekcija na verzijo.</li> <li>Seznam izdaj v obratnem kronološkem vrstnem redu (najnovejše na vrhu).</li> <li>Zapis vseh datumov v <code>YYYY-MM-DD</code> formatu. (Na primer: <code>2012-06-02</code> za <code>2. junij 2012</code>.) Je mednarnodno, <a href="https://xkcd.com/1179/">smiselno</a> in neodvisno od jezika.</li> <li>Eksplicitna omemba ali projekt sledi <a href="https://semver.org/">semantičnim verzijam</a>.</li> <li>Vsaka verzija bi morala: <ul> <li>Imeti seznam njenih datumov izdaje v zgornjem formatu.</li> <li>Skupine sprememb, ki opisujejo njihove vplive na projekt, kot sledi:</li> <li><code>Added</code> za nove lastnosti.</li> <li><code>Changed</code> za spremembe obstoječih lastnosti.</li> <li><code>Deprecated</code> za nekoč stabilne lastnosti, ki bodo odstranjene v prihajajočih verzijah.</li> <li><code>Removed</code> za zastarele lastnosti, ki so odstranjene v tej izdaji.</li> <li><code>Fixed</code> za kakršne koli popravke hroščev.</li> <li><code>Security</code> za povabilo uporabnikom, da nadgradijo v primeru varnostnih ranljivosti.</li> </ul></li> </ul> <h3>Kako zmanjšati potreben trud?</h3> <p>Vedno imejte <code>"Unreleased"</code> sekcijo na vrhu za sledenje katerih koli sprememb.</p> <p>To služi dvema namenoma:</p> <ul> <li>Ljudje lahko vidijo, katere spremembe lahko pričakujejo v prihajajočih izdajah</li> <li>Pri izdaji, morate tako samo spremembiti <code>"Unreleased"</code> v številko verzije in dodati nov naslov <code>"Unreleased"</code> na vrh.</li> </ul> <h3>Kaj spravi samoroga v jok?</h3> <p>Dobro … pojdimo skozi.</p> <ul> <li><strong>Odlaganje sprememb git dnevnikov poslanih sprememb.</strong> Temu se izogibajte, saj s tem ne pomagate nikomur.</li> <li><strong>Nepoudarjanje zastarelosti.</strong> Ko uporabniki nadgradijo iz ene verzije na drugo, bi moralo biti enostavno jasno, ko nekaj ne bo več delovalo.</li> <li><strong>Datumi v lokalnih oblikah.</strong> V ZDA, uporabniki dajo mesec na prvo mesto ("06-02-2012" za 2. junij, 2012, kar je brez smisla), medtem ko mnogi ostali uporabniki drugod po svetu pišejo "2 June 2012" robotskega izgleda, vendar izgovorijo to drugače. "2012-06-02" deluje logično po večini in se ne prekriva na dvoumne načine z ostalimi oblikami datumov. To je tudi <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO standard</a>. Tako je to priporočljiva oblika datuma za dnevnike sprememb.</li> </ul> <p>Tega je še več. Pomagajte zbrati te solze samoroga preko <a href="https://github.com/olivierlacan/keep-a-changelog/issues">odprtja težave</a> ali zahtevka potega.</p> <h3>Ali obstaja standardna oblika dnevnika sprememb?</h3> <p>Na žalost ne. Vendar mirno kri. Vem, da besno hitite najti to povezavo v vodiču dnevnika sprememb GNU ali v datoteki dveh odstavkov "guideline" GNU NEWS. Stilski vodič GNU je lep začetek, vendar je na žalost preveč enostaven. S tem ni nič narobe, vendar ko uporabniki potrebujejo vodič, je redko v pomoč. Posebej, ko je za reševati veliko situacij in posebnih primerov.</p> <p>Ta projekt <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">vsebuje, kar upamo, da bo postalo boljša datoteka konvencij CHANGELOG</a>. Mislimo, da status quo ni dovolj dober in mislimo, da lahko kot skupnost naredimo boljšo konvencijo, če poskusimo izvleči dobre prakse iz realnih programskih projektov. Prosimo, poglejte naokoli in si zapomnite, da <a href="https://github.com/olivierlacan/keep-a-changelog/issues">diskusije in predlogi za izboljšave so dobrodošli</a>!</p> <h3>Kako se mora dnevnik sprememb imenovati?</h3> <p>Če niste uspeli razbrati iz zgornjega primera, je <code>CHANGELOG.md</code> najboljša konvencija do sedaj.</p> <p>Nekateri projekti uporabljajo tudi <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> itd.</p> <p>Gre za zmešnjavo. Vsa ta imena ljudem samo otežijo najti dnevnik sprememb.</p> <h3>Zakaj uporabniki ne morejo uporabiti enostavno samo <code>git log</code> sprememb?</h3> <p>Ker so spremembe dnevnika polne šuma - privzeto. Lahko bi naredili ustrezen dnevnik sprememb tudi v hipotetičnem projektu, ki ga poganjajo popolni ljudje, ki nikoli ne naredijo napak, nikoli ne pozabijo poslati novih datotek in nikoli ne zamudijo nobenega dela refaktorizacije. Razlog pošiljke (commit-a) je dokumentirati en atomičen korak v procesu preko katerega se koda razvija iz enega stanja v drugo. Razlog dnevnika sprememb je dokumentiranje omembe vrednih sprememb med temi stanji.</p> <p>Kakor obstaja razlika med dobrimi komentarji in samo kodo, tako je razlika med dnevnikom sprememb in dnevnikom git commit-a: eden opisuje <em>zakaj</em>, drugi pa <em>kako</em>.</p> <h3>Ali se da dnevnik sprememb samodejno razlčeniti?</h3> <p>Je težko, ker uporabniki sledijo divje različnim formatom in imenom datotek.</p> <p><a href="https://github.com/tech-angels/vandamme/">Vandamme</a> je Ruby gem, ki ga je ustvarila ekipa <a href="https://gemnasium.com/">Gemnasium</a>. Razčlenjuje mnoge (vendar ne vse) dnevnike sprememb odprto kodnih projektov.</p> <h3>Zakaj razlikovanje med črkovanjem "CHANGELOG" in "change log"?</h3> <p>"CHANGELOG" je ime same datoteke. Je nekoliko glasno, vendar je to zgodovinska konvencija, kateri sledi mnogo odprto kodnih projektov. Drugi primeri podobnih datotek vključujejo <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>, in <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CONTRIBUTING.md"><code>CONTRIBUTING</code></a>.</p> <p>Ime z velikimi črkami (kar je datoteko v starih operacijskih sistemih prikazalo na vrhu) je uporabljeno, da se povleče pozornost nanje. Ker gre za pomembne meta podatke o projektu, so lahko uporabne za kogarkoli, ki namerava uporabiti ali prispevati, precej enako kot <a href="https://shields.io/">značke odprto kodnih projektov</a>.</p> <p>Ko se sklicujemo na "change log", govorimo o funkciji te datoteke: beleženje sprememb.</p> <h3>Kaj pa povlečene izdaje?</h3> <p>T.i. yanked ali povlečene izdaje so verzije, ki so bile primorane biti potegnjene zaradi resnega hrošča ali varnostne težave. Pogostokrat se te verzije niti ne pojavijo v dnevnikih sprememb. Vendar bi se morale. Prikazane bi morale biti sledeče:</p> <p><code>## [0.0.5] - 2014-12-13 [YANKED]</code></p> <p>Oznaka <code>[YANKED]</code> je izpisana z velikimi črkami z razlogom. Pomembno je, da jo uporabniki opazijo. Ker je obdana z oglatimi oklepaji, jo je tudi enostavnejše razčleniti programsko.</p> <h3>Ali bi morali kadarkoli prepisati dnevnik sprememb?</h3> <p>Seveda. Vedno obstajajo dobri razlogi, kako izboljšati dnevnik sprememb. Odpiranje zahtevkov potegov je pogostokrat priporočljivo, da se doda manjkajoče izdaje odprtokodnih projektov z nevzdrževanimi dnevniki sprememb.</p> <p>Možno je tudi, da odkrijete, da ste pozabili nasloviti pomembne spremembe v opombah verzije. Očitno je pomembno, da vaš dnevnik sprememb v tem primeru posodobite.</p> <h3>Kako lahko pomagam?</h3> <p>Ta dokument ni <strong>dejstvo</strong>; je osebno temeljito premišljeno mnenje, skupaj z informacijami in primeri, ki smo jih zbrali. Čeprav ponujamo dejanski <a href="https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md">CHANGELOG</a> v <a href="https://github.com/olivierlacan/keep-a-changelog">GitHub repozitoriju</a>, namenoma ni ustvarjene primerne <em>izdaje</em> ali jasnega seznama pravil za sledenje (kot ima to npr. <a href="https://semver.org/">SemVer.org</a>).</p> <p>To je zato, ker želimo, da naša skupnost doseže soglasje. Verjamemo, da je razprava tako pomembna kot končni rezultat.</p> <p>Torej, prosimo <a href="https://github.com/olivierlacan/keep-a-changelog"><strong>pridružite se</strong></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> |