Algoritmekader

We ontwikkelen het Algoritmekader op een open manier via Github. Bekijk de ontwikkelomgeving van het Algoritmekader.

Dit is de Github repo voor het Algoritmekader Op deze pagina lees je hoe je kunt bijdragen aan de ontwikkeling van het Algoritmekader. Boven deze tekst vind je de bestanden voor het kader. We gebruiken Markdown en Mkdocs. Meer daarover lees je onder punt 5.

Hoe kun je bijdragen?

Dat kan op verschillende manieren. Kijk welke manier jou het beste past. 1 t/m 5 zijn geschikte manieren voor gebruikers die nog niet zo bekend zijn met Github. 5 en 6 Geven input voor ervaren Github gebruikers, die op de voor hen bekende manieren een bijdrage kunnen leveren.

1. Sluit je aan bij een werkgroep

Regelmatig starten er nieuwe werkgroepen op bouwblokken of thema's. Deelname kost gemiddeld 3-4 uur per week. Wil je op een van de onderwerpen meewerken? Stuur dan een bericht naar [email protected] 

2. Neem deel aan een sprintreview

We werken in sprints van 3 of 4 weken, gevolgd door een open online review. Zo blijf je op de hoogte en kun je een bijdrage leveren. Bekijk de agenda op Algoritmes Pleio voor de komende bijeenkomsten.

3. Stuur een e-mail naar [email protected]

1. Stuur ons je vraag of opmerking, met een duidelijke toelichting. We reageren binnen enkele dagen op je mail.
2. Het team van het Algoritmekader pakt jouw issue op en neemt mogelijk contact op voor verduidelijking of oplossing.

4. Maak een issue aan

1. Via Issues kan je bestaande issues bekijken of een nieuwe aanmaken.
2. Gebruik daarvoor de knop new issue.
3. Schrijf je vraag of opmerking is en geef een heldere toelichting.
4. Anderen kunnen comments toevoegen aan jouw issue.
5. Het team van het Algoritmekader pakt jouw issue op en neemt mogelijk contact op voor verduidelijking of oplossing.

5. Stuur een pull request

Kun je niet uit de voeten met de issues? Bijvoorbeeld omdat je verschillende wijzigingsvoorstellen wilt doen. We houden het aantal collaborators zeer beperkt. Gebruik bijvoorbeeld Fork en doe een Pull Request. Het team van Algoritmekader bekijkt daarna jouw aanpassingen en kan bij akkoord jouw aanpassingen mergen. Er zijn ook andere manieren om een pull request te doen. Meer daarover.

We werken met Markdown bestanden. Dit bestandsformaat wordt door veel verschillende tools ondersteund, en maakt het eenvoudig versiebeheer toe te passen. Tijdens de ontwikkelfase gebruiken we mkdocs en material for mkdocs voor de presentatie op de ontwikkelomgeving. Zo werken we direct aan de interactiviteit en flexibiliteit van het kader. Uiteindelijk landt het Algoritmekader op een bestaande overheidswebsite zoals Digitale Overheid.

6. Iets aanpassen in de navigatie van de website?

We maken gebruik van mkdocs en material for mkdocs om de documentatie inzichtelijk te maken op een website. In het bestand mkdocs.yml bestand staan de settings voor deze website. In principe hoef je hier niets aan aan te passen. Onderdeel van deze settings is de navigatie voor de site (welke kopjes zijn zichtbaar, en welke kopjes vallen daaronder). Dit staat in de nav: sectie. Indien je een kopje wilt toevoegen, kan dat in deze sectie.

Vragen?

Maak een Issue aan op GitHub. Of mail [email protected]