New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Dutch translation of 1.0.0 #211
Changes from 4 commits
fa16059
b5a19ae
338926b
911acf7
59fa8be
8d3a007
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,299 @@ | ||
--- | ||
description: Keep a Changelog | ||
title: Keep a Changelog | ||
language: nl | ||
version: 1.0.0 | ||
--- | ||
|
||
- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" | ||
- gemnasium = "https://gemnasium.com/" | ||
- gh = "https://github.com/olivierlacan/keep-a-changelog" | ||
- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" | ||
- semver = "http://semver.org/" | ||
- shields = "http://shields.io/" | ||
- thechangelog = "http://5by5.tv/changelog/127" | ||
- vandamme = "https://github.com/tech-angels/vandamme/" | ||
- iso = "http://www.iso.org/iso/home/standards/iso8601.htm" | ||
- ghr = "https://help.github.com/articles/creating-releases/" | ||
|
||
.header | ||
.title | ||
%h1 Houd een Changelog bij | ||
%h2 Laat je vrienden geen git logs in changelogs dumpen. | ||
|
||
= link_to changelog do | ||
Versie | ||
%strong= current_page.metadata[:page][:version] | ||
|
||
%pre.changelog= File.read("CHANGELOG.md") | ||
|
||
.answers | ||
%h3#what | ||
%a.anchor{ href: "#what", aria_hidden: "true" } | ||
Wat is een changelog? | ||
|
||
%p | ||
Een changelog is een bestand met een zorgvuldig samengestelde, chronologische lijst | ||
van noemenswaardige aanpassingen voor elke versie van een project. | ||
|
||
%h3#why | ||
%a.anchor{ href: "#why", aria_hidden: "true" } | ||
Waarom een changelog bijhouden? | ||
|
||
%p | ||
Om het makkelijker te maken voor gebruikers en programmeurs om precies te zien welke | ||
noemenswaardige aanassingen er gedaan zijn tussen elke release (of versie) van het project. | ||
|
||
%h3#who | ||
%a.anchor{ href: "#who", aria_hidden: "true" } | ||
Wie heeft een changelog nodig? | ||
|
||
%p | ||
Mensen hebben dat nodig. Of het nou consumenten of developers zijn, eindgebruikers van | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: developers => ontwikkelaars There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: nou => nu There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: |
||
software zijn mensen die er om gevenwat er in de software zit die ze gebruiken. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo: gevenwat => geven wat |
||
Als de software veranderd, wil men weten wat en hoe. | ||
|
||
.good-practices | ||
%h3#how | ||
%a.anchor{ href: "#how", aria_hidden: "true" } | ||
Hoe maak ik een goed changelog? | ||
|
||
%h4#principles | ||
%a.anchor{ href: "#principles", aria_hidden: "true" } | ||
Richtlijnen | ||
|
||
%ul | ||
%li | ||
Changelogs zijn <em>voor mensen</em>, niet voor machines. | ||
%li | ||
Er zou een vermelding moeten zijn voor elke versie. | ||
There should be an entry for every single version. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. remove: the English text is still in the file |
||
%li | ||
Aanpassingen van het zelfde type moeten gegroepeerd worden. | ||
%li | ||
Versies en secties souden linkbaar moeten zijn. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo: souden =>zouden |
||
%li | ||
De laatste versie staat bovenaan. | ||
%li | ||
De release datum van elke versie word weergegeven. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: "release" => "datum van uitgave" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "release" is een bekende term in de programmeer wereld. Ook bij Nederlandstalige programmeurs. Ik denk dat als we het vervangen voor bijvoorbeeld "uitgave", je meer onduidelijkheid creëert dan er mee oplost. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Daar kan ik me in vinden 👍 (this suggestion can be ignored) |
||
%li | ||
Geef aan of je #{link_to "Semantic Versioning", semver} gebruikt. | ||
|
||
%a.anchor{ href: "#types", aria_hidden: "true" } | ||
%h4#types Types of changes | ||
|
||
%ul | ||
%li | ||
%code Added | ||
voor nieuwe functionaliteit. | ||
%li | ||
%code Changed | ||
voor aanpassingen aan bestaande functionaliteit. | ||
%li | ||
%code Deprecated | ||
voor functionaliteit die binnenkort komt te vervallen. | ||
%li | ||
%code Removed | ||
voor functionaliteit die vanaf nu vervallen is. | ||
%li | ||
%code Fixed | ||
voor bug fixes. | ||
%li | ||
%code Security | ||
voor aanpassingen met betrekking tot veiligheid. | ||
|
||
.effort | ||
|
||
%h3#effort | ||
%a.anchor{ href: "#effort", aria_hidden: "true" } | ||
Hoe kan ik zo min mogelijk moeite stoppen in het bijhouden van een changelog? | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: Hoe kan ik, met zo min mogelijk moeite, een changelog bij houden? |
||
|
||
%p | ||
Houd bovenin een <code>Unreleased</code> sectie bij met aanpassingen voor de komende release. | ||
|
||
%p Dit heeft twee doelen: | ||
|
||
%ul | ||
%li | ||
Mensen kunnen zien wat ze kunnen verwachten in aankomende releases. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: Mensen kunnen zien wat te verwachten in de aankomende release. |
||
%li | ||
Als je een release doet kan je eenvoudig de <code>Unreleased</code> sectie | ||
aanpassen naar een nieuwe release sectie. | ||
|
||
.bad-practices | ||
%h3#bad-practices | ||
%a.anchor{ href: "#bad-practices", aria_hidden: "true" } | ||
Kan een changelog slecht zijn? | ||
|
||
%p Ja. Hier een paar manieren waarop je een changelog behoorlijk onbruikbaar kan maken. | ||
|
||
%h4#log-diffs | ||
%a.anchor{ href: "#log-diffs", aria_hidden: "true" } | ||
Commit log diffs | ||
|
||
%p | ||
Commit log diffs gebruiken als een changelog is een slecht idee: | ||
ze staan vol met ruis. Denk bijvoorbeeld aan merge commits, commits met | ||
onduidelijke titels, documentatie aanpassingen etc. | ||
|
||
%p | ||
Het doel van een commit bericht is om één enkele stap in de evolutie van de | ||
code te beschrijven. | ||
|
||
%p | ||
Het doel van een changelog is om noemenswaardige aanpassingen te documenteren, | ||
vaak over meerdere commits, en om deze duidelijk naar de eindgebruiker te communiceren. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo: commits, en => commits en suggestion: om deze zo duidelijk mogelijk naar de eindgebruiker te communiceren. |
||
|
||
%h4#ignoring-deprecations | ||
%a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" } | ||
Deprecations negeren | ||
|
||
%p | ||
Wanneer mensen upgraden van de ene naar de andere versie, | ||
moet het overduidelijk zijn als er iets niet meer zal werken. | ||
Het moet mogelijk zijn om te upgraden naar een versie met deprications, | ||
afhanlekijkheden van de deprications weg te halen, en vervolgens | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. type: afhanlekijkheden => afhankelijkheden There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In je aanpassing heb je het veranderd naar "vervolgens de deprications weg te halen, en vervolgens de upgrade...", naar mijn mening klinkt het dubbele gebruik van "vervolgens" niet heel goed 🤔 misschien dat "vervolgens de deprications weg te halen, en daarna de upgrade..." een beter alternatief is? |
||
de upgrade kunnen doen naar de versie waar de deprications removals zijn geworden. | ||
|
||
%p | ||
Geef altijd op zijn minst de deprications, removals en changes met grote impact aan in je changelog. | ||
|
||
%h4#confusing-dates | ||
%a.anchor{ href: "#confusing-dates", aria_hidden: "true" } | ||
Verwarrende datums | ||
|
||
%p | ||
Datum notaties verschillen van land tot land, en het is vaak moeilijk om | ||
een notatie te vinden die makkelijk te lezen is en intuitief is voor iedereen. | ||
|
||
Het voordeel van de notatie <code>2017-07-17</code> is dat het jaar, maand en dag | ||
op volgorde van grootte laat zien. Daarom, en het feit dat dit een #{link_to "ISO standaard", iso} | ||
is, is dit de aanbevolen datum notatie voor changelog releases. | ||
|
||
%aside | ||
Dit is niet alles. Help mij antipatterns te verzamelen door | ||
= link_to "een issue", issues | ||
of een pull request aan te maken. | ||
|
||
.frequently-asked-questions | ||
%h3#frequently-asked-questions | ||
%a.anchor{ href: "#frequently-asked-questions", aria_hidden: "true" } | ||
Veel Gestelde Vragen | ||
|
||
%h4#standard | ||
%a.anchor{ href: "#standard", aria_hidden: "true" } | ||
Is er een standaard changelog template? | ||
|
||
%p | ||
Niet echt. Er is de GNU changelog style guide, en de twee paragrafen GNU NEWS bestand "richtlijnen". | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: "..., en de twee paragrafen GNU NEWS bestand..." => "..., en het twee paragrafen langen GNU NEWS bestand..." |
||
Beiden zijn niet volledig genoeg. | ||
|
||
%p | ||
Dit project poogt | ||
= link_to "een betere changelog standaard", changelog | ||
te creëren. Dit op basis van bewezen "good practices" uit de open source wereld. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: remove "bewezen" (proven is not used in the English version) |
||
|
||
%p | ||
Opbouwende kritiek, discussie en suggesties voor verbetering | ||
= link_to "zijn welkom.", issues | ||
|
||
|
||
%h4#filename | ||
%a.anchor{ href: "#filename", aria_hidden: "true" } | ||
Wat zou de changelog bestandsnaam moeten zijn? | ||
|
||
%p | ||
Noem het <code>CHANGELOG.md</code>. Sommige projecten gebruiken | ||
<code>HISTORY</code>, <code>NEWS</code> of <code>RELEASES</code>. | ||
|
||
%p | ||
Je kan denken dat de bestandsnaam niet heel belanrijk is, | ||
maar waarom zou je het de eindgebruikers moeilijker maken om de changelog te vinden? | ||
|
||
%h4#github-releases | ||
%a.anchor{ href: "#github-releases", aria_hidden: "true" } | ||
Wat denk je van GitHub Releases? | ||
|
||
%p | ||
Het is een goed initiatief. #{link_to "Releases", ghr} kan gebruikt worden | ||
om simpele git tags (bijvoorbeeld een tag met naam <code>v1.0.0</code>) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: "bijvoorbeeld een tag met naam..." => "bijvoorbeeld een tag met de naam..." |
||
te veranderen in uitgebreide release notes door deze handmatig toe te voegen of | ||
door geannoteerde git tag berichten te gebruiken om release notes te genereren. | ||
|
||
%p | ||
GitHub Releases maken changelog wat alleen getoond kan worden aan gebruikers | ||
binnen de context van GitHub. Het is mogelijk om deze dicht bij het format | ||
te krijgen wat wij hier promoten, maar er zal iets meer werk voor nodig zijn. | ||
|
||
%p | ||
De huidige versie van GitHub releases is naar mijn mening niet | ||
echt goed vindbaar voor gebruikers, in tegenstelling tot de typische | ||
bestanden die in een naam in hoofdletters hebben | ||
(<code>README</code>, <code>CONTRIBUTING</code>, etc.). | ||
Een ander knelpunt is dat de interface geen links toestaat naar | ||
commit logs van elke release. | ||
|
||
%h4#automatic | ||
%a.anchor{ href: "#automatic", aria_hidden: "true" } | ||
Kunnen changelogs automatisch geparsed worden? | ||
|
||
%p | ||
Dat is lasig, mensen gebruiken immers veel verschillende formats en bestandsnamen. | ||
|
||
%p | ||
#{link_to "Vandamme", vandamme} is een Ruby gem van het | ||
#{link_to "Gemnasium", gemnasium} team wat de changelogs van veel (maar niet alle) | ||
open source projecten kan parsen. | ||
|
||
|
||
%h4#yanked | ||
%a.anchor{ href: "#yanked", aria_hidden: "true" } | ||
Wat doen we met teruggetrokken (yanked) releases? | ||
|
||
%p | ||
Teruggetrokken releases zijn versies die teruggetrokken zijn als gevolg | ||
van een serieuze bug of beveiligings probleem. Vaak zijn ze niet eens te zien in | ||
de changelogs. Dat zou wel moeten. Zo zou je een teruggetrokken release moeten tonen: | ||
|
||
%p <code>## 0.0.5 - 2014-12-13 [YANKED]</code> | ||
|
||
%p | ||
De <code>[YANKED]</code> tag is in hoofdletters voor een reden. Het is belanrijk | ||
dat mensen dit zien. Omdat het tussen blokhaken genoteerd is, is het ook makkelijker | ||
automatisch te parsen. | ||
|
||
|
||
%h4#rewrite | ||
%a.anchor{ href: "#rewrite", aria_hidden: "true" } | ||
Mag je een changelog aanpassen/herschrijven? | ||
|
||
%p | ||
Natuurlijk. Er zijn goede redenen om een changelog te verbeteren. | ||
Ik open regelmatig een pull request om missende releases toe te | ||
voegen aan open source projecten met een slecht onderhouden changelog. | ||
|
||
%p | ||
Het kan ook zo zijn dat je ontdekt dat je een belanrijke aanpassing niet | ||
vermeld hebt in je changelog. Het is dan natuurlijk zaak om dit alsnog | ||
in je changelog te vermelden. | ||
|
||
%h4#contribute | ||
%a.anchor{ href: "#contribute", aria_hidden: "true" } | ||
Hoe kan ik bijdragen? | ||
|
||
%p | ||
Dit document is niet de <strong>waarheid</strong>; het is mijn | ||
weloverwogen mening, samen met wat informatie en voorbeelden die ik verzameld heb. | ||
|
||
%p | ||
Dit heb ik gedaan omdat ik wil dat de programmeer gemeenschap een consensus bereikt. | ||
Ik denk dat de discussie net zo belanrijk is als het eindresultaat. | ||
|
||
%p | ||
Dus <strong>#{link_to "alle hulp is welkom", gh}</strong>. | ||
|
||
.press | ||
%h3 Conversaties | ||
%p | ||
Ik was te gast bij #{link_to "The Changelog podcast", thechangelog} om te praten over | ||
waarom een changelog belanrijk zou moeten zijn voor programmeurs, en over mijn motivatie achter dit project. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo "belanrijk" => "belangrijk" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion: "...een changelog belangrijk zou moeten zijn voor programmeurs, ..." => "...een changelog belangrijk is voor programmers, ..." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: aanassingen => aanpassingen