Skip to content

Latest commit

 

History

History
99 lines (62 loc) · 7.39 KB

CONTRIBUTING.md

File metadata and controls

99 lines (62 loc) · 7.39 KB
Raw

Bijdragen aan de BIO2

Bedankt dat je de tijd neemt om een bijdrage te leveren! 🫶

We waarderen alle soorten bijdragen enorm.

Zie de Inhoudsopgave voor verschillende manieren waarop je kan bijdragen aan de BIO2. Lees de onderstaande informatie voordat je aan de slag gaat.

Inhoudsopgave

Inbreng

  • 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 en licentievoorwaarden.
  • Voorstellen aanleveren op de BIO via Github betekent niet dat jouw inbreng ook altijd verwerkt wordt.

Disclaimer

🚧 De teksten op deze Github zijn nog niet definitief en kunnen nog substantieel veranderen. We vinden het wel belangrijk om iedereen vroeg in het proces te betrekken.

👶 We zijn nieuw met het werken in Github. We zullen dus fouten maken. We vinden het belangrijk dat we open beleid kunnen ontwikkelingen. Help ons dus vooral om dat steeds beter te doen!

⌛ We werken met een klein team. Het kan dus even duren voordat we reageren. Dat betekent niet dat we jouw inbreng niet waarderen!

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.

Ik heb een vraag

Maak een issue aan

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. Dat doe je als volgt:

  1. Gebruik daarvoor de knop new issue of deze link.
  2. Schrijf je vraag of opmerking is en geef een heldere toelichting.
  3. Anderen kunnen nu opmerkingen toevoegen aan jouw issue.
  4. Het team van de BIO zal het issue labelen als question en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van de BIO contact op voor een verduidelijking of een oplossing.

Ik wil iets bijdragen

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

Vertegenwoordiging via koepelorganisaties

De interbestuurlijke werkgroep-BIO zorgt voor het onderhoud op de BIO. Onder het voorzitterschap van BZK zijn in de werkgroep de 4 overheidskoepels vertegenwoordigd: CIO Rijk, Vereniging Nederlandse Gemeenten, InterProvinciaal Overleg en Unie van Waterschappen. In de werkgroep zijn de vier overheidslagen vertegenwoordigd (Rijk, waterschappen, gemeenten en provincies). De eerste vaststelling en verdere ontwikkeling van de BIO verloopt via de werkgroep.

Ik wil een fout / bug melden

Heb je een foutje gevonden in de BIO? 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.

  1. Gebruik daarvoor de knop new issue.
  2. Beschrijf de fout duidelijk en geef een heldere toelichting. Voeg waar mogelijk een screenshot toe.
  3. Het team van de BIO zal het issue labelen als bug en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van de BIO contact op voor een verduidelijking of een oplossing.

Ik wil 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 team van de BIO 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.

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 toevoeging? Het is aan jou om het team van de BIO te overtuigen dat dit een nuttige toevoeging is aan de BIO. Houd in gedachten dat we toevoegingen willen die nuttig zijn voor de meerderheid van de overheid en niet slechts voor een kleine groep of een overheidslaag.

Een issue aanmaken

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

  1. Gebruik daarvoor de knop new issue.
  2. Beschrijf duidelijk jouw suggestie en geef een heldere toelichting en onderbouwing waarom dit een goede toevoeging zal zijn aan de BIO.
  3. Het team van de BIO zal deze issue labelen als enhancement en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van de BIO 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 BIO.

Een pull-request maken

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.

Het team van de BIO bekijkt daarna jouw aanpassingen en kan bij akkoord jouw aanpassingen mergen. Er zijn ook andere manieren om een pull request te doen. Meer daarover.

Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van de BIO.

Hoe we werken op Github

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 BIO toe te passen.

Daarnaast maken gebruik van mkdocs en material for mkdocs.