Standaarden kunnen we alleen samen maken. We waarderen alle suggesties, zijn blij met feedback en verwelkomen verbeteringen in dit project. Brede samenwerking leidt tot de beste standaarden.
Voorheen werd er toegewerkt naar één openbare consultatie waarmee een standaard eenmalig werd getoetst bij stakeholders. Bij de nieuwe werkwijze is er sprake van een voortdurende afstemming met partijen waarbij meerdere instrumenten worden ingezet, t.w.:
Deze instrumenten zijn onderdeel van de openbare consultatie. Er zal dus sprake zijn van een voortdurende consultatie van de stakeholders, waarmee ook de kans ontstaat om de standaard voortdurend te verbeteren op aangeven van de gebruikers.
‘Issues’ en ‘Pull Requests’ zijn dus meer dan welkom.
Het is niet nodig om software of documentatie te schrijven om toch bij te dragen. De ontwikkeling is ook gebaat bij gerapporteerde problemen, suggesties voor wijzigingen en vragen over dingen die (nog) onduidelijk zijn. Om dit te doen kan een issue worden gemaakt. Op de supportpagina’s van GitHub staat uitleg over het maken van issues.
Maak om bij te dragen aan de documentatie of software van de ZGW API’s een zogenaamde Pull Request. Lees alles over hoe git (en GitHub) werkt in deze introductie over git flow](https://guides.github.com/introduction/flow/).
Dit project hanteert het OneFlow branching model. Maak je wijzigingen op een nieuwe ‘feature branch’ met de naam feature/naam-die-bijdrage-beschrijft. Zorg voor heldere beschrijvingen voor iedere commit, zodat degenen die de bijdrage moeten beoordelen een goed beeld hebben van wat de bedoeling is.
Wanneer de bijdrage compleet op de nieuwe feature branch staat kun je een Pull Request maken. Dit is, zoals de naam zegt, een verzoek aan de eigenaren van de repository om de branch met wijzigingen op te halen en in het project te voegen. Verzoek daarbij is om elke Pull Request te voorzien van een duidelijke beschrijving en eventuele issue nummers die met behulp van de Pull Request worden opgelost.
Alle bijdragen worden beoordeeld in een review proces. Je kunt zelf ook specifiek aan een teamlid vragen om een review.
Het kan zijn dat een Pull Request direct kan worden ingevoegd. Vaak is het echter nodig om nog het e.e.a. te verbeteren aan de Pull Request voordat deze in het project kan worden ingevoegd. Feedback op de Pull Request kan komen van de eigenaren van de standaard, van andere belanghebbenden of van geautomatiseerde tests.
Wanneer de gewijzigde documentatie en code door de menselijke review en geautomatiseerde test komt, worden de wijzigingen van de Pull Request in het project gevoegd.
Het team wat aan de ZGW API’s werkt doet dit volgens de agile scrum methodiek. Iedere sprint duurt vier weken. Gemeenten leveren user stories rond zaakgericht werken, welke vervolgens worden vertaald naar wat nodig is in de RESTful API specificatie.
Er worden vier scrum boards gebruikt om de flow naar resultaat in elke sprint te faciliteren.
2. Scrum ZGW Voorbereiding Nieuwe user stories en issues komen hier op de backlog. Wanneer zij worden geprioriteerd komen ze in de flow om ze ‘ready te maken’ zodat ze opgepakt kunnen worden in de volgende sprint.
1. Scrum ZGW Realisatie Huidige Sprint Vanuit de kolom “Ready for Sprint” worden tijdens de maandelijkse sprint planning userstories opgepakt die uitgevoerd gaan worden. Deze komen dan in de eerste kolom van het scrum board gericht op realisatie van de API specificatie.
3. Scrum ZGW Gereed Archief Op dit board is terug te vinden welke user story gereed was in welke sprint.
4. Out of scope Op dit bord komen alle user stories die buiten scope zijn voor ZGW API’s en die functionaliteit beschrijven voor gebruik van de ZGW API’s buiten zaakgericht werken.
Zowel het board Scrum ZGW Voorbereiding als Scrum ZGW Realisatie Sprint x bevat een kolom voor review. Tijdens de voorbereiding worden user stories klaargemaakt om in een volgende sprint uitgevoerd te worden. Daar hoort een review bij: voldoet de user story aan de Definition of Ready? Na de realisatie vindt opnieuw een review plaats, van iedere Pull Request waarmee een wijziging of toevoeging op de standaard wordt gedaan.
Reviews worden vaak aan specifieke personen gevraagd, maar iedereen kan een review uitvoeren. Wanneer de beoordeling binnen je competenties valt, geef de review dan prioriteit boven eventuele andere bijdragen zodat iedereen zo snel mogelijk verder kan.