Translate version 1.0.0 to Czech

This commit is contained in:
Jan Havránek 2017-08-22 20:56:22 +02:00
parent 93f11868b1
commit 232974e331

View File

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