mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-30 09:14:12 +02:00
Fixed typos and added suggestions from @vanhooferwin and @ericcornelissen
This commit is contained in:
parent
911acf7b00
commit
59fa8be48d
@ -42,15 +42,15 @@ version: 1.0.0
|
|||||||
|
|
||||||
%p
|
%p
|
||||||
Om het makkelijker te maken voor gebruikers en programmeurs om precies te zien welke
|
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.
|
noemenswaardige aanpassingen er gedaan zijn tussen elke release (of versie) van het project.
|
||||||
|
|
||||||
%h3#who
|
%h3#who
|
||||||
%a.anchor{ href: "#who", aria_hidden: "true" }
|
%a.anchor{ href: "#who", aria_hidden: "true" }
|
||||||
Wie heeft een changelog nodig?
|
Wie heeft een changelog nodig?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Mensen hebben dat nodig. Of het nou consumenten of developers zijn, eindgebruikers van
|
Mensen hebben het nodig. Of het nu consumenten of ontwikkelaars zijn, eindgebruikers van
|
||||||
software zijn mensen die er om gevenwat er in de software zit die ze gebruiken.
|
software zijn mensen die er om geven wat er in de software zit die ze gebruiken.
|
||||||
Als de software veranderd, wil men weten wat en hoe.
|
Als de software veranderd, wil men weten wat en hoe.
|
||||||
|
|
||||||
.good-practices
|
.good-practices
|
||||||
@ -71,7 +71,7 @@ version: 1.0.0
|
|||||||
%li
|
%li
|
||||||
Aanpassingen van het zelfde type moeten gegroepeerd worden.
|
Aanpassingen van het zelfde type moeten gegroepeerd worden.
|
||||||
%li
|
%li
|
||||||
Versies en secties souden linkbaar moeten zijn.
|
Versies en secties zouden linkbaar moeten zijn.
|
||||||
%li
|
%li
|
||||||
De laatste versie staat bovenaan.
|
De laatste versie staat bovenaan.
|
||||||
%li
|
%li
|
||||||
@ -106,7 +106,7 @@ version: 1.0.0
|
|||||||
|
|
||||||
%h3#effort
|
%h3#effort
|
||||||
%a.anchor{ href: "#effort", aria_hidden: "true" }
|
%a.anchor{ href: "#effort", aria_hidden: "true" }
|
||||||
Hoe kan ik zo min mogelijk moeite stoppen in het bijhouden van een changelog?
|
Hoe kan ik, met zo min mogelijk moeite, een changelog bij houden?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Houd bovenin een <code>Unreleased</code> sectie bij met aanpassingen voor de komende release.
|
Houd bovenin een <code>Unreleased</code> sectie bij met aanpassingen voor de komende release.
|
||||||
@ -115,7 +115,7 @@ version: 1.0.0
|
|||||||
|
|
||||||
%ul
|
%ul
|
||||||
%li
|
%li
|
||||||
Mensen kunnen zien wat ze kunnen verwachten in aankomende releases.
|
Mensen kunnen zien wat te verwachten in de aankomende release.
|
||||||
%li
|
%li
|
||||||
Als je een release doet kan je eenvoudig de <code>Unreleased</code> sectie
|
Als je een release doet kan je eenvoudig de <code>Unreleased</code> sectie
|
||||||
aanpassen naar een nieuwe release sectie.
|
aanpassen naar een nieuwe release sectie.
|
||||||
@ -152,7 +152,7 @@ version: 1.0.0
|
|||||||
Wanneer mensen upgraden van de ene naar de andere versie,
|
Wanneer mensen upgraden van de ene naar de andere versie,
|
||||||
moet het overduidelijk zijn als er iets niet meer zal werken.
|
moet het overduidelijk zijn als er iets niet meer zal werken.
|
||||||
Het moet mogelijk zijn om te upgraden naar een versie met deprications,
|
Het moet mogelijk zijn om te upgraden naar een versie met deprications,
|
||||||
afhanlekijkheden van de deprications weg te halen, en vervolgens
|
vervolgens de deprications weg te halen, en vervolgens
|
||||||
de upgrade kunnen doen naar de versie waar de deprications removals zijn geworden.
|
de upgrade kunnen doen naar de versie waar de deprications removals zijn geworden.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
@ -185,13 +185,13 @@ version: 1.0.0
|
|||||||
Is er een standaard changelog template?
|
Is er een standaard changelog template?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Niet echt. Er is de GNU changelog style guide, en de twee paragrafen GNU NEWS bestand "richtlijnen".
|
Niet echt. Er is de GNU changelog style guide, en het twee paragrafen lange GNU NEWS bestand "richtlijnen".
|
||||||
Beiden zijn niet volledig genoeg.
|
Beiden zijn niet volledig genoeg.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Dit project poogt
|
Dit project poogt
|
||||||
= link_to "een betere changelog standaard", changelog
|
= link_to "een betere changelog standaard", changelog
|
||||||
te creëren. Dit op basis van bewezen "good practices" uit de open source wereld.
|
te creëren. Dit op basis van "good practices" uit de open source wereld.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Opbouwende kritiek, discussie en suggesties voor verbetering
|
Opbouwende kritiek, discussie en suggesties voor verbetering
|
||||||
@ -216,7 +216,7 @@ version: 1.0.0
|
|||||||
|
|
||||||
%p
|
%p
|
||||||
Het is een goed initiatief. #{link_to "Releases", ghr} kan gebruikt worden
|
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>)
|
om simpele git tags (bijvoorbeeld een tag met de naam <code>v1.0.0</code>)
|
||||||
te veranderen in uitgebreide release notes door deze handmatig toe te voegen of
|
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.
|
door geannoteerde git tag berichten te gebruiken om release notes te genereren.
|
||||||
|
|
||||||
@ -258,7 +258,7 @@ version: 1.0.0
|
|||||||
%p <code>## 0.0.5 - 2014-12-13 [YANKED]</code>
|
%p <code>## 0.0.5 - 2014-12-13 [YANKED]</code>
|
||||||
|
|
||||||
%p
|
%p
|
||||||
De <code>[YANKED]</code> tag is in hoofdletters voor een reden. Het is belanrijk
|
De <code>[YANKED]</code> tag is in hoofdletters voor een reden. Het is belangrijk
|
||||||
dat mensen dit zien. Omdat het tussen blokhaken genoteerd is, is het ook makkelijker
|
dat mensen dit zien. Omdat het tussen blokhaken genoteerd is, is het ook makkelijker
|
||||||
automatisch te parsen.
|
automatisch te parsen.
|
||||||
|
|
||||||
@ -267,27 +267,27 @@ version: 1.0.0
|
|||||||
%a.anchor{ href: "#rewrite", aria_hidden: "true" }
|
%a.anchor{ href: "#rewrite", aria_hidden: "true" }
|
||||||
Mag je een changelog aanpassen/herschrijven?
|
Mag je een changelog aanpassen/herschrijven?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Natuurlijk. Er zijn goede redenen om een changelog te verbeteren.
|
Natuurlijk. Er zijn goede redenen om een changelog te verbeteren.
|
||||||
Ik open regelmatig een pull request om missende releases toe te
|
Ik open regelmatig een pull request om missende releases toe te
|
||||||
voegen aan open source projecten met een slecht onderhouden changelog.
|
voegen aan open source projecten met een slecht onderhouden changelog.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Het kan ook zo zijn dat je ontdekt dat je een belanrijke aanpassing niet
|
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
|
vermeld hebt in je changelog. Het is dan natuurlijk zaak om dit alsnog
|
||||||
in je changelog te vermelden.
|
in je changelog te vermelden.
|
||||||
|
|
||||||
%h4#contribute
|
%h4#contribute
|
||||||
%a.anchor{ href: "#contribute", aria_hidden: "true" }
|
%a.anchor{ href: "#contribute", aria_hidden: "true" }
|
||||||
Hoe kan ik bijdragen?
|
Hoe kan ik bijdragen?
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Dit document is niet de <strong>waarheid</strong>; het is mijn
|
Dit document is niet de <strong>waarheid</strong>; het is mijn
|
||||||
weloverwogen mening, samen met wat informatie en voorbeelden die ik verzameld heb.
|
weloverwogen mening, samen met wat informatie en voorbeelden die ik verzameld heb.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Dit heb ik gedaan omdat ik wil dat de programmeer gemeenschap een consensus bereikt.
|
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.
|
Ik denk dat de discussie net zo belanrijk is als het eindresultaat.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Dus <strong>#{link_to "alle hulp is welkom", gh}</strong>.
|
Dus <strong>#{link_to "alle hulp is welkom", gh}</strong>.
|
||||||
@ -296,4 +296,4 @@ version: 1.0.0
|
|||||||
%h3 Conversaties
|
%h3 Conversaties
|
||||||
%p
|
%p
|
||||||
Ik was te gast bij #{link_to "The Changelog podcast", thechangelog} om te praten over
|
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.
|
waarom een changelog belanrijk is programmeurs, en over mijn motivatie achter dit project.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user