Bijdragen aan deze standaard

🙇‍♀️ Bedankt voor je bijdrage!

We begrijpen dat een standaard als deze alleen kan worden opgesteld in samenwerking met zoveel mogelijk technologen uit de publieke sector, beleidsmakers en geïnteresseerden. We waarderen daarom inbreng, stellen feedback op prijs, verwelkomen verbeteringen aan dit project en staan erg open voor samenwerking.

Bijdragen aan de Nederlandse Vertaling

Deze Nederlandse vertaling van de Standaard voor Publieke Code is een Nederlandstalig communityproject georganiseerd vanuit Code for NL. We verwelkomen bijdragen van iedereen. Als je wilt bijdragen aan de vertaling, kun je een issue aanmaken of een pull request indienen in de GitHub-repository van de vertaling. Of je kunt deze per e-mail sturen naar standaardvoorpubliekecode@codefor.nl.

Maandelijks organiseren we een gebruikerssessie waarin we de Nederlandse Vertaling van de Standaard voor Publieke Code en het gebruik daarvan in de praktijk bespreken. Tussentijds is er de mogelijkheid met elkaar te communiceren via de chat omgeving van Code for NL.

Voertaal in deze community is, vanwege de aard van het project, Nederlands. Dat wil zeggen dat issues en commit messages in het Nederlands dienen te worden geschreven. De vertaling zelf is in het Nederlands, maar de Engelse versie van de Standaard voor Publieke Code is leidend wat betreft de strekking en inhoud van de tekst.

Talige aanpassingen kunnen we direct doorvoeren. Inhoudelijke suggesties brengen we in bij de upstream Standard for Public Code. Iedereen is welkom om deel te nemen. Wil je een uitnodiging ontvangen voor de volgende sessie? Stuur dan een e-mail naar standaardvoorpubliekecode@codefor.nl.

Bijdragen aan de upstream Standard for Public Code

Problemen, suggesties en vragen in kwesties

Een globaal overzicht van de ontwikkeling die we al hebben geschetst, vind je in de roadmap. Help de ontwikkeling door problemen te melden, wijzigingen voor te stellen en vragen te stellen. Om dit te doen, kun je een GitHub-issue aanmaken voor dit project in de GitHub-issues voor de upstream Standard for Public Code.

Je hoeft niets aan onze code of documentatie te wijzigen om bij te dragen!

Documentatie en code in pull requests

Als je iets aan de documentatie of code van een van onze projecten wilt toevoegen, moet je een pull request indienen.

Als je GitHub nog nooit hebt gebruikt, ga dan snel aan de slag met GitHub-workflow begrijpen of volg een van de geweldige gratis interactieve cursussen in GitHub-vaardigheden over het werken met GitHub en het werken met MarkDown, de manier waarop de documentatie van dit project is opgesteld.

Dit project heeft een Creative Commons Zero v1.0 Universal-licentie, wat in essentie betekent dat het project samen met jouw bijdragen in het publieke domein valt, in welke jurisdictie dan ook, en dat iedereen ermee kan doen wat hij of zij wil.

1. Je wijzigingen aanbrengen

Bijdragen moeten voldoen aan de vereisten in de criteria van de upstream Standard for Public Code zelf. Beoordelaars zorgen er ook voor dat bijdragen in lijn zijn met de waarden van publieke code. Bovendien controleren ze of de bijdrage voldoet aan de standaarden en coherent blijft met het algehele werk.

Dit project gebruikt het GitFlow branch model en de GitFlow workflow. Als je deze repository hebt geforkt, zorg er dan voor dat je een feature branch aanmaakt volgens het GitFlow-model.

Bundel je wijzigingen in een bijdrage met daarbij een bijdragebericht dat ze uitlegt. Als er meer dan één type wijziging nodig is, groepeer logisch gerelateerde wijzigingen dan in aparte bijdragen. In sommige gevallen kan een enkele set wijzigingen meerdere gedocumenteerde problemen oplossen. Zorg er in dat geval voor dat je alle problemen vermeldt die zijn opgelost. Wanneer je nieuwe bestanden toevoegt, selecteer je bestandsformaten die gemakkelijk in een diff kunnen worden bekeken, bijvoorbeeld .svg heeft de voorkeur boven een binaire afbeelding. Documenteer keuzes of beslissingen die je maakt in het bijdragebericht. Hierdoor kan iedereen in de toekomst op de hoogte blijven van je keuzes.

Als je code toevoegt, zorg er dan voor dat je de relevante documentatie en tests hebt toegevoegd en bijgewerkt voordat je pull request indient. Zorg ervoor dat je tests schrijft die het gedrag van de nieuw toegevoegde of gewijzigde code laten zien.

Toepasselijk beleid

Op dit moment implementeert de upstream Standard for Public Code geen specifiek openbaar beleid.

Stijl

Tekstinhoud moet normaal gesproken één regel per zin bevatten, zonder regelafbreking, zodat de diff-uitvoer gemakkelijker te bekijken is. We willen echter benadrukken dat het belangrijker is dat je jouw bijdrage levert dan dat je je zorgen maakt over spelling en typografie. We helpen je graag om het goed te doen in ons beoordelingsproces en we hebben ook een aparte kwaliteitscontrole voordat er een nieuwe uitgave wordt uitgebracht.

Te volgen standaarden

Dit zijn de standaarden die de upstream Standard for Public Code gebruikt. Zorg ervoor dat je bijdragen hierop aansluiten, zodat ze gemakkelijker kunnen worden samengevoegd.

• IETF RFC 2119 - voor trefwoorden op vereisteniveau

• Web Content Accessibility Guidelines 2.1 - voor leesbaarheid

2. Pull request

Voeg bij het indienen van het pull request een beschrijving van het probleem dat je probeert op te lossen en het kwestienummer dat deze pull request oplost. Het heeft de voorkeur dat bij elke pull request indien mogelijk één kwestie wordt aangepakt. In sommige gevallen kan een enkele set veranderingen meerdere kwesties oplossen. Zorg er in dat geval voor dat je alle kwestienummers vermeldt die zijn opgelost.

3. Verbeteren

Alle bijdragen moeten door iemand worden beoordeeld. De Foundation for Public Code streeft ernaar ervoor te zorgen dat beheerders beschikbaar zijn om bijdragen te beoordelen met als doel om binnen twee werkdagen feedback te geven.

Het kan zijn dat je bijdrage meteen kan worden samengevoegd door een beheerder. Meestal moet een nieuwe pull request echter worden verbeterd voordat deze kan worden samengevoegd. Andere medewerkers (of hulprobots) hebben misschien feedback. Als dit het geval is, zal de beoordelende beheerder je helpen om je documentatie en code te verbeteren.

Als je documentatie en code door de menselijke beoordeling zijn gekomen, wordt deze samengevoegd.

4. Vieren

Jouw ideeën, documentatie en code zijn een integraal onderdeel van dit project geworden. Jij bent de open source-held die we nodig hebben!

Sterker nog, open gerust een pull request om je naam toe te voegen aan AUTHORS en eeuwige naamsvermelding te krijgen.

Talen en vertalingen

De primaire taal van de upstream Standard for Public Code is Engels.

Versies in andere talen worden door de community naar beste vermogen beschikbaar gesteld. Deze vertalingen zijn mogelijk niet up-to-date met de Engelse versie. Ontbrekende vertalingen vormen geen belemmering voor uitgave. We nodigen je uit om te helpen bestaande community-vertalingen van de standaard te onderhouden en nieuwe toe te voegen.