mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-29 00:34:09 +02:00
Translate version 1.0.0 to Czech
This commit is contained in:
Jan Havránek
parent
93f11868b1
commit
232974e331
@ -1,7 +1,7 @@
|
||||
---
|
||||
description: Keep a Changelog
|
||||
title: Keep a Changelog
|
||||
language: en
|
||||
description: Udržuj Changelog
|
||||
title: Udržuj Changelog
|
||||
language: cs
|
||||
version: 1.0.0
|
||||
---
|
||||
|
||||
@ -18,11 +18,11 @@ version: 1.0.0
|
||||
|
||||
.header
|
||||
.title
|
||||
%h1 Keep a Changelog
|
||||
%h2 Don’t let your friends dump git logs into changelogs.
|
||||
%h1 Udržuj Changelog
|
||||
%h2 Nenech své kamarády sypat git logy do changelogů.
|
||||
|
||||
= link_to changelog do
|
||||
Version
|
||||
Verze
|
||||
%strong= current_page.metadata[:page][:version]
|
||||
|
||||
%pre.changelog= File.read("CHANGELOG.md")
|
||||
@ -30,285 +30,279 @@ version: 1.0.0
|
||||
.answers
|
||||
%h3#what
|
||||
%a.anchor{ href: "#what", aria_hidden: "true" }
|
||||
What is a changelog?
|
||||
Co je to changelog?
|
||||
|
||||
%p
|
||||
A changelog is a file which contains a curated, chronologically
|
||||
ordered list of notable changes for each version of a project.
|
||||
Changelog je soubor, který obsahuje organizovaný, chronologicky seřazený
|
||||
seznam podstatných změn pro každou verzi daného projektu.
|
||||
|
||||
%h3#why
|
||||
%a.anchor{ href: "#why", aria_hidden: "true" }
|
||||
Why keep a changelog?
|
||||
Proč udržovat changelog?
|
||||
|
||||
%p
|
||||
To make it easier for users and contributors to see precisely what
|
||||
notable changes have been made between each release (or version) of
|
||||
the project.
|
||||
Aby uživatelé a přispěvatelé přesně věděli, jaké podstatné změny byly
|
||||
provedeny mezi jednotlivými vydáními (verzemi) daného projektu.
|
||||
|
||||
%h3#who
|
||||
%a.anchor{ href: "#who", aria_hidden: "true" }
|
||||
Who needs a changelog?
|
||||
Kdo potřebuje changelog?
|
||||
|
||||
%p
|
||||
People do. Whether consumers or developers, the end users of
|
||||
software are human beings who care about what's in the software. When
|
||||
the software changes, people want to know why and how.
|
||||
Lidé. Ať už se jedná o spotřebitele nebo vývojáře, koncoví uživatelé
|
||||
softwaru jsou lidská stvoření, kterým záleží na tom, co software obsahuje.
|
||||
Když se daný software změní, lidé chtějí vědět proč a jak.
|
||||
|
||||
.good-practices
|
||||
%h3#how
|
||||
%a.anchor{ href: "#how", aria_hidden: "true" }
|
||||
How do I make a good changelog?
|
||||
Jak vytvořit dobrý changelog?
|
||||
|
||||
%h4#principles
|
||||
%a.anchor{ href: "#principles", aria_hidden: "true" }
|
||||
Guiding Principles
|
||||
Hlavní zásady
|
||||
|
||||
%ul
|
||||
%li
|
||||
Changelogs are <em>for humans</em>, not machines.
|
||||
Changelogy jsou <em>pro lidi</em>, ne pro stroje.
|
||||
%li
|
||||
There should be an entry for every single version.
|
||||
Changelog by měl obsahovat záznam pro každou verzi.
|
||||
%li
|
||||
The same types of changes should be grouped.
|
||||
Stejné typy změn by měly být seskupené.
|
||||
%li
|
||||
Versions and sections should be linkable.
|
||||
Měla by existovat možnost odkazovat na jednotlivé verze a sekce.
|
||||
%li
|
||||
The latest version comes first.
|
||||
Poslední verze je na prvním místě.
|
||||
%li
|
||||
The release date of each versions is displayed.
|
||||
U každé verze je poznamenáno datum jejího vydání.
|
||||
%li
|
||||
Mention whether you follow #{link_to "Semantic Versioning", semver}.
|
||||
Zmiňte, zda se držíte #{link_to "Sémantického verzování", semver}
|
||||
|
||||
%a.anchor{ href: "#types", aria_hidden: "true" }
|
||||
%h4#types Types of changes
|
||||
%h4#types Typy změn
|
||||
|
||||
%ul
|
||||
%li
|
||||
%code Added
|
||||
for new features.
|
||||
pro nové funkce.
|
||||
%li
|
||||
%code Changed
|
||||
for changes in existing functionality.
|
||||
pro změny v existující funkcionalitě.
|
||||
%li
|
||||
%code Deprecated
|
||||
for soon-to-be removed features.
|
||||
pro funkce, které budou brzy odstraněny.
|
||||
%li
|
||||
%code Removed
|
||||
for now removed features.
|
||||
pro odstraněné funkce.
|
||||
%li
|
||||
%code Fixed
|
||||
for any bug fixes.
|
||||
pro opravy chyb.
|
||||
%li
|
||||
%code Security
|
||||
in case of vulnerabilities.
|
||||
v případě bezpečnostních zranitelností.
|
||||
|
||||
.effort
|
||||
|
||||
%h3#effort
|
||||
%a.anchor{ href: "#effort", aria_hidden: "true" }
|
||||
How can I reduce the effort required to maintain a changelog?
|
||||
Jak minimalizovat úsilí potřebné k udržování changelogu?
|
||||
|
||||
%p
|
||||
Keep an <code>Unreleased</code> section at the top to track upcoming
|
||||
changes.
|
||||
Udržováním <code>Unreleased</code> sekce na začátku souboru pro zaznamenávání
|
||||
nadcházejících změn.
|
||||
|
||||
%p This serves two purposes:
|
||||
%p To plní hned dva účely:
|
||||
|
||||
%ul
|
||||
%li
|
||||
People can see what changes they might expect in upcoming releases
|
||||
Lidé uvidí, jaké změny mohou očekávat v následujících vydáních
|
||||
%li
|
||||
At release time, you can move the <code>Unreleased</code> section
|
||||
changes into a new release version section.
|
||||
V čas vydání stačí přesunout změny z <code>Unreleased</code> sekce
|
||||
do sekce nového vydání.
|
||||
|
||||
.bad-practices
|
||||
%h3#bad-practices
|
||||
%a.anchor{ href: "#bad-practices", aria_hidden: "true" }
|
||||
Can changelogs be bad?
|
||||
Mohou být changelogy špatné?
|
||||
|
||||
%p Yes. Here are a few ways they can be less than useful.
|
||||
%p Ano. Zde je několik případů, kdy mohou být opakem užitečného.
|
||||
|
||||
%h4#log-diffs
|
||||
%a.anchor{ href: "#log-diffs", aria_hidden: "true" }
|
||||
Commit log diffs
|
||||
Diffy z commit logu
|
||||
|
||||
%p
|
||||
Using commit log diffs as changelogs is a bad idea: they're full of
|
||||
noise. Things like merge commits, commits with obscure titles,
|
||||
documentation changes, etc.
|
||||
Používání diffů z commit logu jako changelogu je špatný nápad:
|
||||
jsou plné šumu. Obsahují věci jako merge commity, commity s
|
||||
nejasnými nadpisy, změny v dokumentaci, atd.
|
||||
|
||||
%p
|
||||
The purpose of a commit is to document a step in the evolution of
|
||||
the source code. Some projects clean up commits, some don't.
|
||||
Účelem commitu je zdokumentovat krok v evoluci zdrojového kódu.
|
||||
Některé projekty commity pročišťují, jiné zas ne.
|
||||
|
||||
%p
|
||||
The purpose of a changelog entry is to document the noteworthy
|
||||
difference, often across multiple commits, to communicate them
|
||||
clearly to end users.
|
||||
Účelem záznamu v changelogu je zdokumentovat podstatné změny,
|
||||
často napříč několika commity, a jasně je sdělit koncovým uživatelům.
|
||||
|
||||
%h4#ignoring-deprecations
|
||||
%a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" }
|
||||
Ignoring Deprecations
|
||||
Ignorování odstraněných funkcí
|
||||
%p
|
||||
Když lidé upgradují z jedné verze na druhou, mělo by jim být bolestně
|
||||
jasné, když se něco rozbije. Mělo by být možné nejprve upgradovat na verzi,
|
||||
která oznámí, jaké funkce budou odstraněny, dané funkce odstranit
|
||||
a poté upgradovat na verzi, kde jsou zmíněné funkce již odstraněny.
|
||||
|
||||
%p
|
||||
When people upgrade from one version to another, it should be
|
||||
painfully clear when something will break. It should be possible to
|
||||
upgrade to a version that lists deprecations, remove what's
|
||||
deprecated, then upgrade to the version where the deprecations
|
||||
become removals.
|
||||
|
||||
%p
|
||||
If you do nothing else, list deprecations, removals, and any
|
||||
breaking changes in your changelog.
|
||||
Když už nic jiného, je dobré alespoň vypsat odstraněné funkce a
|
||||
změny, které něco rozbíjí, do changelogu.
|
||||
|
||||
|
||||
%h4#confusing-dates
|
||||
%a.anchor{ href: "#confusing-dates", aria_hidden: "true" }
|
||||
Confusing Dates
|
||||
Matoucí data
|
||||
|
||||
%p
|
||||
Regional date formats vary throughout the world and it's often
|
||||
difficult to find a human-friendly date format that feels intuitive
|
||||
to everyone. The advantage of dates formatted like
|
||||
<code>2017-07-17</code> is that they follow the order of largest to
|
||||
smallest units: year, month, and day. This format also doesn't
|
||||
overlap in ambiguous ways with other date formats, unlike some
|
||||
regional formats that switch the position of month and day numbers.
|
||||
These reasons, and the fact this date format is an
|
||||
#{link_to "ISO standard", iso} are why it is the recommended date
|
||||
format for changelog entries.
|
||||
Regionální formáty dat se liší napříč světem a je často složité
|
||||
najít formát, který je přátelský a intuitivní pro všechny.
|
||||
Výhodou dat formátovaných jako <code>2017-07-17</code> je pořadí
|
||||
jednotek od největší po nejmenší: rok, měsíc a den. Tento formát
|
||||
se navíc nepřekrývá s jinými, narozdíl od některých regionálních
|
||||
formátů, které prohazují pozici měsíce a dne. Díky těmto důvodům,
|
||||
a také faktu, že je tento formát #{link_to "ISO standard", iso},
|
||||
je doporučeným formátem pro záznamy v changelogu.
|
||||
|
||||
%aside
|
||||
There’s more. Help me collect these antipatterns by
|
||||
= link_to "opening an issue", issues
|
||||
or a pull request.
|
||||
Je toho však víc. Pomozte mi sesbírat tyto antipatterny
|
||||
= link_to "otevřením issue", issues
|
||||
nebo pull requestu.
|
||||
|
||||
.frequently-asked-questions
|
||||
%h3#frequently-asked-questions
|
||||
%a.anchor{ href: "#frequently-asked-questions", aria_hidden: "true" }
|
||||
Frequently Asked Questions
|
||||
Časko kladené otázky
|
||||
|
||||
%h4#standard
|
||||
%a.anchor{ href: "#standard", aria_hidden: "true" }
|
||||
Is there a standard changelog format?
|
||||
Existuje pro formát changelogu nějaký standard?
|
||||
|
||||
%p
|
||||
Not really. There's the GNU changelog style guide, or the two-
|
||||
paragraph-long GNU NEWS file "guideline". Both are inadequate or
|
||||
insufficient.
|
||||
Ne. Je tu GNU stylová příručka pro changelog, nebo ta dvouodstavcová
|
||||
GNU "směrnice" pro NEWS soubor. Ani jedno však není vhodné či dostačující.
|
||||
|
||||
%p
|
||||
This project aims to be
|
||||
= link_to "a better changelog convention.", changelog
|
||||
It comes from observing good practices in the open source
|
||||
community and gathering them.
|
||||
Tento projekt má za cíl být
|
||||
= link_to "lepší konvencí pro changelog.", changelog
|
||||
Pochází z pozorování osvědčených postupů v open source komunitě a jejich
|
||||
shromažďování.
|
||||
|
||||
%p
|
||||
Healthy criticism, discussion and suggestions for improvements
|
||||
= link_to "are welcome.", issues
|
||||
Zdravá kritika, diskuse a návrhy na zlepšení
|
||||
= link_to "jsou vítány.", issues
|
||||
|
||||
|
||||
%h4#filename
|
||||
%a.anchor{ href: "#filename", aria_hidden: "true" }
|
||||
What should the changelog file be named?
|
||||
Jak by se soubor s changelogem měl jmenovat?
|
||||
|
||||
%p
|
||||
Call it <code>CHANGELOG.md</code>. Some projects use
|
||||
<code>HISTORY</code>, <code>NEWS</code> or <code>RELEASES</code>.
|
||||
Pojmenujte ho <code>CHANGELOG.md</code>. Některé projekty
|
||||
používají <code>HISTORY</code>, <code>NEWS</code> nebo <code>RELEASES</code>.
|
||||
|
||||
%p
|
||||
While it's easy to think that the name of your changelog file
|
||||
doesn't matter that much, why make it harder for your end users to
|
||||
consistently find notable changes?
|
||||
Zatímco je snadné si myslet, že na názvu souboru vašeho changelogu
|
||||
až tak nezáleží, proč koncovým uživatelům ztěžovat hledání významných
|
||||
změn?
|
||||
|
||||
%h4#github-releases
|
||||
%a.anchor{ href: "#github-releases", aria_hidden: "true" }
|
||||
What about GitHub Releases?
|
||||
A co GitHub Releases?
|
||||
|
||||
%p
|
||||
It's a great initiative. #{link_to "Releases", ghr} can be used to
|
||||
turn simple git tags (for example a tag named <code>v1.0.0</code>)
|
||||
into rich release notes by manually adding release notes or it can
|
||||
pull annotated git tag messages and turn them into notes.
|
||||
Je to skvělá iniciativa. Služba #{link_to "Releases", ghr} může být
|
||||
použita na proměnu obyčejných git tagů (například tag s názvem
|
||||
<code>v1.0.0</code>) na bohaté poznámky k vydání manuálním přidáním
|
||||
daných poznámek, nebo může pullnout zprávy z anotovaných git tagů
|
||||
a udělat poznámky k vydání z nich.
|
||||
|
||||
%p
|
||||
GitHub Releases create a non-portable changelog that can only be
|
||||
displayed to users within the context of GitHub. It's possible to
|
||||
make them look very much like the Keep a Changelog format, but it
|
||||
tends to be a bit more involved.
|
||||
GitHub Releases však vytvářejí nepřenosný changelog, který může být
|
||||
zobrazen uživatelům jen v kontextu GitHubu. Je možné je udělat
|
||||
velmi podobné formátu projektu Udržuj Changelog, ale to má
|
||||
tendenci být trochu náročnější.
|
||||
|
||||
%p
|
||||
The current version of GitHub releases is also arguably not very
|
||||
discoverable by end-users, unlike the typical uppercase files
|
||||
(<code>README</code>, <code>CONTRIBUTING</code>, etc.). Another
|
||||
minor issue is that the interface doesn't currently offer links to
|
||||
commit logs between each release.
|
||||
Aktuální verze GitHub Releases také pravděpodobně není příliš
|
||||
objevitelná koncovými uživateli, narozdíl od typických souborů
|
||||
s názvy psanými velkými písmeny (<code>README</code>,
|
||||
<code>CONTRIBUTING</code>, atd.). Další menší problém je, že
|
||||
Releases aktuálně nenabízí možnost odkazovat na commit logy mezi
|
||||
jednotlivými vydáními.
|
||||
|
||||
%h4#automatic
|
||||
%a.anchor{ href: "#automatic", aria_hidden: "true" }
|
||||
Can changelogs be automatically parsed?
|
||||
Mohou changelogy být automaticky parsovány?
|
||||
|
||||
%p
|
||||
It’s difficult, because people follow wildly different formats and
|
||||
file names.
|
||||
Je to složité, protože lidé používají mnoho rozdílných formátů a názvů
|
||||
souborů.
|
||||
|
||||
%p
|
||||
#{link_to "Vandamme", vandamme} is a Ruby gem created by the
|
||||
#{link_to "Gemnasium", gemnasium} team and which parses many (but
|
||||
not all) open source project changelogs.
|
||||
#{link_to "Vandamme", vandamme} je Ruby gem vytvořený týmem
|
||||
#{link_to "Gemnasium", gemnasium}, který parsuje mnoho (ale ne všechny)
|
||||
changelogy open source projektů.
|
||||
|
||||
|
||||
%h4#yanked
|
||||
%a.anchor{ href: "#yanked", aria_hidden: "true" }
|
||||
What about yanked releases?
|
||||
A co zpětně stažená vydání?
|
||||
|
||||
%p
|
||||
Yanked releases are versions that had to be pulled because of a
|
||||
serious bug or security issue. Often these versions don't even
|
||||
appear in change logs. They should. This is how you should display
|
||||
them:
|
||||
Stažená vydání jsou verze, které musely být zpětně odebrány kvůli vážné
|
||||
chybě nebo bezpečnostním rizikům. Tyto verze se často v changelogu ani
|
||||
neobjevují, ale měly by. Zobrazovat by se měly takto:
|
||||
|
||||
%p <code>## 0.0.5 - 2014-12-13 [YANKED]</code>
|
||||
|
||||
%p
|
||||
The <code>[YANKED]</code> tag is loud for a reason. It's important
|
||||
for people to notice it. Since it's surrounded by brackets it's also
|
||||
easier to parse programmatically.
|
||||
Tag <code>[YANKED]</code> je křiklavý naschvál. Je důležité, aby si ho
|
||||
lidé všimli. Díky tomu, že je v hranatých závorkách, je také jednodušší ho
|
||||
parsovat programem.
|
||||
|
||||
|
||||
%h4#rewrite
|
||||
%a.anchor{ href: "#rewrite", aria_hidden: "true" }
|
||||
Should you ever rewrite a changelog?
|
||||
Měl by se changelog někdy přepisovat?
|
||||
|
||||
%p
|
||||
Sure. There are always good reasons to improve a changelog. I
|
||||
regularly open pull requests to add missing releases to open source
|
||||
projects with unmaintained changelogs.
|
||||
Jistě. Vždy se najde dobrý důvod pro zlepšení changelogu. Sám často otevírám
|
||||
pull requesty pro přidání chybějících vydání v open source projektech s
|
||||
neudržovanými changelogy.
|
||||
|
||||
%p
|
||||
It's also possible you may discover that you forgot to address a
|
||||
breaking change in the notes for a version. It's obviously important
|
||||
for you to update your changelog in this case.
|
||||
Je také možné, že zjistíte, že v poznámkách k verzi ve vašem projektu není
|
||||
zmíněna změna, která něco rozbila. V tom případě je samozřejmě důležité,
|
||||
aby byl changelog aktualizován.
|
||||
|
||||
|
||||
%h4#contribute
|
||||
%a.anchor{ href: "#contribute", aria_hidden: "true" }
|
||||
How can I contribute?
|
||||
Jak mohu přispět?
|
||||
|
||||
%p
|
||||
This document is not the <strong>truth</strong>; it’s my carefully
|
||||
considered opinion, along with information and examples I gathered.
|
||||
Tento dokument není čistá <strong>pravda</strong>; je to můj pečlivě
|
||||
zvážený názor, společně s informacemi a příklady, které jsem shromáždil.
|
||||
|
||||
%p
|
||||
This is because I want our community to reach a consensus. I believe
|
||||
the discussion is as important as the end result.
|
||||
Je tomu tak proto, že chci aby naše komunita došla ke společné shodě.
|
||||
Věřím, že diskuse je stejně důležitá jako konečný výsledek.
|
||||
|
||||
%p
|
||||
So please <strong>#{link_to "pitch in", gh}</strong>.
|
||||
Takže prosím, <strong>#{link_to "přiložte ruku k dílu", gh}</strong>.
|
||||
|
||||
.press
|
||||
%h3 Conversations
|
||||
%h3 Rozhovory
|
||||
%p
|
||||
I went on #{link_to "The Changelog podcast", thechangelog}
|
||||
to talk about why maintainers and contributors should care about changelogs,
|
||||
and also about the motivations behind this project.
|
||||
Zúčastnil jsem se #{link_to "podcastu The Changelog", thechangelog},
|
||||
abych promluvil o tom, proč by se správci projektů a přispěvatelé měli
|
||||
starat o changelogy a také o motivaci za tímto projektem.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user