diff --git a/nl/criteria/make-contributing-easy.md b/nl/criteria/make-contributing-easy.md index a3a32e5..4179b84 100644 --- a/nl/criteria/make-contributing-easy.md +++ b/nl/criteria/make-contributing-easy.md @@ -14,7 +14,7 @@ Een gedeelde digitale infrastructuur maakt het makkelijker om samen te werken. H - De codebase MOET een openbare issue tracker hebben die suggesties van iedereen accepteert. -- De documentatie MOET linken naar zowel de openbare issue tracker als de ingediende codebase-wijzigingen, bijvoorbeeld in een README-bestand. +- De documentatie MOET linken naar zowel de openbare issue tracker als de ingediende codebase-wijzigingen, bijvoorbeeld in een `README`-bestand. - De codebase MOET communicatiekanalen hebben voor gebruikers en ontwikkelaars, bijvoorbeeld e-maillijsten. @@ -50,7 +50,7 @@ Een gedeelde digitale infrastructuur maakt het makkelijker om samen te werken. H - Houd uw managers op de hoogte van de tijd en middelen die u nodig hebt om andere bijdragers te ondersteunen. -- Zorg ervoor dat de juiste communicatiekanalen voor het stellen van vragen aan beheerders en belanghebbenden gemakkelijk te vinden zijn, bijvoorbeeld in de README. +- Zorg ervoor dat de juiste communicatiekanalen voor het stellen van vragen aan beheerders en belanghebbenden gemakkelijk te vinden zijn, bijvoorbeeld in de `README`. - Zorg ervoor dat de juiste contactgegevens zijn opgenomen in de metadata, bijvoorbeeld in het bestand publiccode.yml. diff --git a/nl/criteria/use-a-coherent-style.md b/nl/criteria/use-a-coherent-style.md index 316dc96..e96b755 100644 --- a/nl/criteria/use-a-coherent-style.md +++ b/nl/criteria/use-a-coherent-style.md @@ -4,40 +4,44 @@ order: 15 --- -# Samenhangende stijl gebruiken +# Gebruik een coherente stijl -Door een consistente en coherente stijl te volgen, kunnen medewerkers in verschillende omgevingen samenwerken. Het verenigen van vocabulaires vermindert wrijving in de communicatie tussen medewerkers. +Door een consistente en coherente stijl te volgen, kunnen bijdragers in verschillende omgevingen samenwerken. Het uniformeren van taalgebruik vermindert wrijving in de communicatie tussen bijdragers. ## Vereisten -- De [codebase](/nl/glossary.html#) MOET een codeer- of schrijfstijlgids gebruiken, ofwel die van de codebase-community zelf of een bestaande waarnaar in de codebase wordt verwezen. +- De [codebase](/nl/glossary.html#codebase) MOET een programmeer- of schrijfstijlgids gebruiken, ofwel die van de codebase-community zelf of een bestaande waarnaar in de codebase wordt verwezen. -- Bijdragen MOETEN geautomatiseerde stijltests doorstaan. +- Bijdragen ZOUDEN aan geautomatiseerde stijltests MOETEN voldoen. -- De stijlgids MOET verwachtingen bevatten voor inline opmerkingen en documentatie voor niet-triviale secties. +- De stijlgids ZOU instructies MOETEN bevatten voor inline opmerkingen en documentatie van niet-triviale secties. -- Het opnemen van verwachtingen voor [begrijpelijk Engels](/nl/glossary.html#) in de stijlgids is OPTIONEEL. +- Het opnemen van instructies voor [eenvoudig Engels](use-plain-english.html) in de stijlgids is OPTIONEEL. ## Hoe te testen -- Bevestig dat de bijdragen in overeenstemming zijn met de stijlgidsen in de documentatie. +- Bevestig dat de bijdragen in overeenstemming zijn met de stijlgidsen genoemd in de documentatie. -- Controleer op de aanwezigheid van geautomatiseerde stijltests. +- Controleer op de aanwezigheid van geautomatiseerde stijltests. ## Beleidsmakers in de publieke sector: wat u moet doen -- Maak, volg en verbeter voortdurend een stijlgids voor [beleid](/nl/glossary.html#) en documentatie, en documenteer dit in de codebase, bijvoorbeeld in de CONTRIBUTING of README. +- Maak, volg en verbeter voortdurend een stijlgids voor [beleid](/nl/glossary.html#beleid) en documentatie, en documenteer dit in de codebase, bijvoorbeeld in de `CONTRIBUTING` of `README`. ## Managers: wat u moet doen -- Neem geschreven taal, bron-, test- en beleidsnormen op in je organisatorische definitie van kwaliteit. +- Neem geschreven taal-, broncode-, test- en beleidsnormen op in je organisatorische definitie van kwaliteit. ## Ontwikkelaars en ontwerpers: wat u moet doen -Als de codebase nog geen technische richtlijnen of andere richtlijnen voor bijdragers heeft, begin dan met het toevoegen van documentatie aan de [repository](/nl/glossary.html#) die beschrijft wat er nu wordt gedaan, bijvoorbeeld in de CONTRIBUTING of README. Een belangrijk doel van het bestand is het communiceren van ontwerpvoorkeuren, naamgevingsconventies en andere aspecten die machines niet eenvoudig kunnen controleren. Richtlijnen moeten bevatten wat er verwacht wordt van [broncodebijdragen](/nl/glossary.html#) zodat ze samengevoegd kunnen worden door de beheerders, inclusief broncode, tests en documentatie. Deze documentatie voortdurend verbeteren en uitbreiden met als doel deze documentatie te ontwikkelen tot technische richtlijnen. +Als de codebase nog geen technische richtlijnen of andere richtlijnen voor bijdragers heeft, begin dan met het toevoegen van documentatie aan de [repository](/nl/glossary.html#repository) die beschrijft wat er nu wordt gedaan, bijvoorbeeld in de `CONTRIBUTING` of `README`. Een belangrijk doel van het bestand is het communiceren van ontwerpvoorkeuren, naamgevingsconventies en andere aspecten die machines niet eenvoudig kunnen controleren. Richtlijnen moeten bevatten wat er verwacht wordt van [broncodebijdragen](/nl/glossary.html#broncode) zodat ze samengevoegd kunnen worden door de beheerders, inclusief broncode, tests en documentatie. Deze documentatie voortdurend verbeteren en uitbreiden met als doel deze documentatie te ontwikkelen tot technische richtlijnen. Bovendien: -- Gebruik een linter. +- Gebruik een linter. -- Voeg linterconfiguraties toe aan de codebase. +- Voeg linterconfiguraties toe aan de codebase. + +## Meer informatie + +* [Programming style](https://en.wikipedia.org/wiki/Programming_style) op Wikipedia.