Bijdragen aan het Digi Handboek

Allereerst, bedankt dat je de tijd wilt nemen om een bijdrage te leveren ❤️

We waarderen alle soorten bijdragen enorm. Zie de inhoudsopgave voor verschillende manieren waarop je kan bijdragen aan het Digi Handboek. Zorg ervoor dat je de relevante hoofdstukken even leest voordat je een bijdrage levert. Het zal het voor het team een stuk makkelijker maken en de ervaring voor alle betrokkenen soepeler laten verlopen. We kijken uit naar je bijdrage!

Opmerking

Werken in Github is voor het Digi Gilde nieuw en experimenteel. Dit vraagt voor ons om een aangepaste werkwijze en hier is bepaalde expertise voor nodig. Het begin is gemaakt en het Digi Gilde team is nog lerende om hier optimaal invulling aan te geven. Hierdoor kan het iets langer duren voordat er wordt gereageerd op suggesties of toevoegingen. We werken aan een duidelijk proces om hier goed mee om te gaan.

Code of Conduct

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 RIG@rijksoverheid.nl.

Ik heb een vraag

Maak een issue aan

Voordat je een issue gaat aanmaken, kan je bekijken of jouw vraag al tussen de bestaande issues staat. Wellicht staat er al een issue tussen die jouw vraag kan beantwoorden.

Als je jouw vraag nog steeds wilt stellen, kan je een issue aanmaken.

Gebruik daarvoor de knop new issue.
Beschrijf je vraag of opmerking en geef een heldere toelichting.
Anderen kunnen nu opmerkingen toevoegen aan jouw issue.
Het Digi Gilde team pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team contact op voor een verduidelijking of een oplossing.

Stel een vraag via mail

Je kan je vragen ook altijd stellen door een mail te sturen naar RIG@rijksoverheid.nl.

Ik wil iets bijdragen

Er zijn verschillende manieren waarop je kan bijdragen. Zie hieronder de mogelijkheden.

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.

Ik wil een suggestie doen of een verbetering voorstellen

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 Digi Gilde team om je suggestie te begrijpen.

Je kan een suggestie doen door een issue aan te maken of door een Pull Request te maken.

Voordat je een suggestie gaat maken

Voordat je een suggestie gaat maken, kan je bekijken of jouw suggestie al tussen de bestaande issues staat. Wellicht bestaat er al een issue die jouw suggestie beschrijft, en zijn we er al mee bezig.
Zoek uit of jouw idee past binnen het doel en de scope van het project. Wat zijn de voordelen van deze functionaliteit of toevoeging? Het is aan jou om de verbetering zo concreet mogelijk aan te bieden.

Een issue aanmaken

Als je jouw suggestie nog steeds wilt doen, kan je een issue aanmaken.

Gebruik daarvoor de knop new issue.
Beschrijf duidelijk jouw suggestie en geef een heldere toelichting en onderbouwing waarom dit een goede toevoeging zal zijn aan het Digi Handboek.
Het Digi Gilde team pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team contact op voor een verduidelijking of een oplossing.

Een pull request maken

Het is nog makkelijker als je suggesties en verbeteringen direct in de code aanbrengt en deze vervolgens als Pull Request aanbiedt. Je kan ook gebruik maken van een Fork en Pull Request.

Het Digi Gilde team pakt jouw pull request zo snel mogelijk op. Mogelijk neemt het team contact op voor een verduidelijking of een oplossing.

Ik wil een fout of bug melden

Heb je een fout of bug gevonden in het Digi Handboek? Dan kan je deze melden door een issue aan te maken.

Voordat je een issue 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.

Gebruik daarvoor de knop new issue.
Beschrijf de fout duidelijk en geef een heldere toelichting. Voeg waar mogelijk een screenshot toe.
Het Digi Gilde team pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team contact op voor een verduidelijking of een oplossing.

Lokaal ontwikkelen

Voor het lokaal ontwikkelen vind je instructies in de README van de repository.