mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-29 16:54:12 +02:00
translated deprications, confusing dates, and 3 FAQ's
This commit is contained in:
parent
fa160598f3
commit
b5a19ae227
@ -149,85 +149,76 @@ version: 1.0.0
|
|||||||
Deprecations negeren
|
Deprecations negeren
|
||||||
|
|
||||||
%p
|
%p
|
||||||
When people upgrade from one version to another, it should be
|
Wanneer mensen upgraden van de ene naar de andere versie,
|
||||||
painfully clear when something will break. It should be possible to
|
moet het overduidelijk zijn als er iets niet meer zal werken.
|
||||||
upgrade to a version that lists deprecations, remove what's
|
Het moet mogelijk zijn om te upgraden naar een versie met deprications,
|
||||||
deprecated, then upgrade to the version where the deprecations
|
afhanlekijkheden van de deprications weg te halen, en vervolgens
|
||||||
become removals.
|
de upgrade kunnen doen naar de versie waar de deprications removals zijn geworden.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
If you do nothing else, list deprecations, removals, and any
|
Geef altijd op zijn minst de deprications, removals en changes met grote impact aan in je changelog.
|
||||||
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
|
Verwarrende datums
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Regional date formats vary throughout the world and it's often
|
Datum notaties verschillen van land tot land, en het is vaak moeilijk om
|
||||||
difficult to find a human-friendly date format that feels intuitive
|
een notatie te vinden die makkelijk te lezen is en intuitief is voor iedereen.
|
||||||
to everyone. The advantage of dates formatted like
|
|
||||||
<code>2017-07-17</code> is that they follow the order of largest to
|
Het voordeel van de notatie <code>2017-07-17</code> is dat het jaar, maand en dag
|
||||||
smallest units: year, month, and day. This format also doesn't
|
op volgorde van grootte laat zien. Daarom, en het feit dat dit een #{link_to "ISO standaard", iso}
|
||||||
overlap in ambiguous ways with other date formats, unlike some
|
is, is dit de aanbevolen datum notatie voor changelog releases.
|
||||||
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.
|
|
||||||
|
|
||||||
%aside
|
%aside
|
||||||
There’s more. Help me collect these antipatterns by
|
Dit is niet alles. Help mij antipatterns te verzamelen door
|
||||||
= link_to "opening an issue", issues
|
= link_to "een issue", issues
|
||||||
or a pull request.
|
of een pull request aan te maken.
|
||||||
|
|
||||||
.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
|
Veel Gestelde Vragen
|
||||||
|
|
||||||
%h4#standard
|
%h4#standard
|
||||||
%a.anchor{ href: "#standard", aria_hidden: "true" }
|
%a.anchor{ href: "#standard", aria_hidden: "true" }
|
||||||
Is there a standard changelog format?
|
Is er een standaard changelog template?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Not really. There's the GNU changelog style guide, or the two-
|
Niet echt. Er is de GNU changelog style guide, en de twee paragrafen GNU NEWS bestand "richtlijnen".
|
||||||
paragraph-long GNU NEWS file "guideline". Both are inadequate or
|
Beiden zijn niet volledig genoeg.
|
||||||
insufficient.
|
|
||||||
|
|
||||||
%p
|
%p
|
||||||
This project aims to be
|
Dit project poogt
|
||||||
= link_to "a better changelog convention.", changelog
|
= link_to "een betere changelog standaard", changelog
|
||||||
It comes from observing good practices in the open source
|
te creëren. Dit op basis van bewezen "good practices" uit de open source wereld.
|
||||||
community and gathering them.
|
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Healthy criticism, discussion and suggestions for improvements
|
Opbouwende kritiek, discussie en suggesties voor verbetering
|
||||||
= link_to "are welcome.", issues
|
= link_to "zijn welkom.", 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?
|
Wat zou de changelog bestandsnaam moeten zijn?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Call it <code>CHANGELOG.md</code>. Some projects use
|
Noem het <code>CHANGELOG.md</code>. Sommige projecten gebruiken
|
||||||
<code>HISTORY</code>, <code>NEWS</code> or <code>RELEASES</code>.
|
<code>HISTORY</code>, <code>NEWS</code> of <code>RELEASES</code>.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
While it's easy to think that the name of your changelog file
|
Je kan denken dat de bestandsnaam niet heel belanrijk is,
|
||||||
doesn't matter that much, why make it harder for your end users to
|
maar waarom zou je het de eindgebruikers moeilijker maken om de changelog te vinden?
|
||||||
consistently find notable changes?
|
|
||||||
|
|
||||||
%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?
|
Wat denk je van GitHub Releases?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
It's a great initiative. #{link_to "Releases", ghr} can be used to
|
Het is een goed initiatief. #{link_to "Releases", ghr} kan gebruikt worden
|
||||||
turn simple git tags (for example a tag named <code>v1.0.0</code>)
|
om simpele git tags (bijvoorbeeld een tag met naam <code>v1.0.0</code>)
|
||||||
into rich release notes by manually adding release notes or it can
|
te veranderen in uitgebreide release notes door deze handmatig toe te voegen of
|
||||||
pull annotated git tag messages and turn them into notes.
|
door geannoteerde git tag berichten te gebruiken om release notes te genereren.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
GitHub Releases create a non-portable changelog that can only be
|
GitHub Releases create a non-portable changelog that can only be
|
||||||
|
Loading…
x
Reference in New Issue
Block a user