Allereerst, bedankt dat je de tijd hebt genomen om een bijdrage te leveren! ❤️
We waarderen alle soorten bijdragen enorm. Zie die Inhoudsopgave voor verschillende manieren waarop je kan bijdragen aan de Nederlandse Richtlijn Digitale Systemen (NeRDS). Zorg ervoor dat je de relevante hoofdstukken even leest voordat je een bijdrage levert. Het zal het voor het team van de NeRDS een stuk makkelijker maken en de ervaring voor alle betrokkenen soepeler laten verlopen. We kijken uit naar alle bijdragen! 🎉
Opmerking
Het ontwikkelen van de NeRDS via GitHub is een bewuste keuze voor transparantie en samenwerking. We werken systematisch aan verschillende bouwblokken en prioriteren deze op basis van waarde en urgentie. Hierdoor kan het voorkomen dat reacties op suggesties of toevoegingen enige tijd vergen, vooral bij onderwerpen die later op de planning staan. We waarderen alle bijdragen en streven ernaar om feedback zo snel mogelijk te verwerken.
Dit project en iedereen die eraan deelneemt, valt onder de Code of Conduct. Door deel te nemen, wordt van je verwacht dat je je aan deze code houdt. Meld onacceptabel gedrag aan bureau.architectuur@minbzk.nl.
Voordat je een Issues gaat aanmaken, kan je bekijken of jouw vraag al tussen de bestaande Issues staat. Wellicht staat er al een issue tussen die jou vraag kan beantwoorden.
Als je jouw vraag nog steeds wilt stellen, kan je een Issue aanmaken.
question en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van de NeRDS contact op voor een verduidelijking of een oplossing.Je kan je vragen ook altijd stellen door een mail te sturen naar bureau.architectuur@minbzk.nl.
Heb je een foutje gevonden in de NeRDS? Dan kan je deze melden door een Issue aan te maken.
Voordat je een Issues gaat aanmaken, kan je bekijken of jouw gevonden fout al tussen de bestaande Issues staat.
Als je de gevonden fout nog steeds wilt melden, kan je een Issue aanmaken.
bug en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van de NeRDS contact op voor een verduidelijking of een oplossing.Ter kennisgeving
Wanneer je bijdraagt aan dit project, moet je ermee akkoord gaan dat je 100% van de inhoud hebt geschreven, dat je de benodigde rechten op de inhoud hebt en dat de inhoud die je bijdraagt mag worden geleverd onder de Code of Conduct.
Heb je een suggestie of wil je een verbetering voorstellen? Dat kan gaan om een compleet nieuwe functionaliteit van de site of om kleine verbeteringen. Het volgen van onderstaande instructie helpt het team van de NeRDS om je suggestie te begrijpen en gerelateerde suggesties te vinden.
Je kan een suggestie doen door een Issue aan te maken of door een Pull Request te maken.
Als je jouw suggestie nog steeds wilt doen, kan je een Issue aanmaken.
enhancement en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van de NeRDS contact op voor een verduidelijking of een oplossing.Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van de NeRDS.
Kun je niet uit de voeten met de issues? Bijvoorbeeld omdat je verschillende wijzigingsvoorstellen wilt doen? Je kan ook gebruik maken van een Fork en een Pull Request.
We werken met Markdown bestanden. Dit is bestandsformaat voor platte tekstbestanden en wordt door veel verschillende tools ondersteund. Dit maakt het eenvoudig om versiebeheer op de NeRDS toe te passen.
Daarnaast maken gebruik van mkdocs en het NLDD Designsysteem om de informatie op een interactieve wijze inzichtelijk te maken op de website van de NeRDS.
Voor bijdragen aan de NeRDS heb je een lokale ontwikkelomgeving nodig:
Installeer uv
Start de development server
uv installeert bij de eerste keer zelf de juiste Python en de afhankelijkheden.
Bekijk je wijzigingen Open http://localhost:8000 in je browser
Controleer je wijzigingen
Dit bouwt de website en controleert de opmaak tegen het designsysteem. Pas je het thema in src/theme aan, draai dan ook just a11y voor de toegankelijkheidscontrole (WCAG 2.1 AA). Beide controles draaien ook op elke pull request.
In het mkdocs.yml bestand staan de settings voor deze website. In richtlijn hoef je hier niets aan aan te passen, maar als je een nieuwe pagina wilt aanmaken kan het nodig zijn om hier een aanpassing in te doen. Onderdeel van deze settings is namelijk de navigatie voor de site (welke pagina's zijn zichtbaar, en welke pagina's vallen daaronder). Dit staat in de nav: sectie. Indien je een nieuwe pagina wilt toevoegen, is het vaak nodig deze wijziging ook door te voeren in het mkdocs.yml bestand.
Een nieuwe richtlijn krijgt bovenaan de pagina een title, een summary en een icon. De kaarten op de startpagina en op het overzicht van richtlijnen worden daaruit opgebouwd. Voor icon kies je een naam uit de iconen van het NLDD Designsysteem; een naam die niet bestaat laat de controle hierboven falen.
assets/ mapGebruik kebab-case, houd de namen kort maar beschrijvend en vermijd speciale karakters. Branch types:
De NeRDS gebruikt semantic versioning voor releases:
Versies worden handmatig beheerd door het NeRDS team:
Als contributor hoef je je geen zorgen te maken over versioning:
Tip: Door duidelijke commit messages te schrijven help je het team om te bepalen welk versienummer verhoogd moet worden.
Helpt u ons door uw feedback te delen? We gebruiken dit om NeRDS te verbeteren. U kunt feedback geven via e-mail of via GitHub Issues.