Workshop
Publieke Code Kick-off
Open werken begint op dag één.
Aan het begin van een opdracht waarin publieke code gemaakt wordt, regelen we samen wat je later niet meer makkelijk regelt: wie eigenaar is, waar gewerkt wordt en welke afspraken er gelden voor bijdragen.
Boek deze workshopPublieke code
Drie momenten in een opdracht
Bij de start, tussentijds en bij oplevering. Elke workshop kan los, samen houden ze een opdracht op koers.
1
Bij de start van een opdracht
Publieke Code Kick-off
Bij de start van een opdracht regelen we samen governance, werkplek en afspraken. Vanaf dag één open.
Je bent hier
2
Tussentijds
Publieke Code Check-up
Halverwege kijken we samen of jullie nog op koers liggen. Bijsturen kan nu nog makkelijk.
Bekijk workshop
3
Bij oplevering of overdracht
Publieke Code Review
Bij oplevering of overdracht leggen we de codebase langs de Standaard. Je weet wat er nog moet gebeuren.
Bekijk workshop
Voor wie
Met wie gaan we aan de slag
Voor opdrachtgevers en leveranciers die aan het begin staan van een opdracht waarin publieke code wordt gemaakt.
Het werkt het best als de opdrachtgever, de opdrachtnemer en het ontwikkelteam samen aan tafel zitten.
Herken je dit?
- Bij de oplevering blijkt wat er mistLicentie, documentatie, eigenaarschap: had je dat maar bij de start geregeld.
- Open source, ooitEerst bouwen, later openbaar maken. Dat later komt er vaak niet van.
- Niemand weet van wie de code isOpdrachtgever en leverancier gaan er allebei van uit dat de ander het regelt.
Wat het oplevert
- Heldere governanceWie eigenaar is van de codebase en wie er onder welke voorwaarden aan bijdraagt.
- Een ingerichte werkplekEen openbare repository met licentie, README en publiccode.yml.
- Afspraken voor bijdragenOver tests, commit messages en het gebruik van AI, vastgelegd in CONTRIBUTING.
- Een checklist voor onderwegDie je bij de check-up en de review weer oppakt.
Aanpak
Wat we gaan doen
We gebruiken de Standaard voor Publieke Code als leidraad, en een checklist die we zelf opstelden na eerdere reviews.
- Intake voorafDe opdracht en de partijen
- GovernanceWie is eigenaar, wie heeft welke rol
- WerkplekRepository inrichten, licentie erop
- DocumentenREADME, publiccode.yml, CONTRIBUTING
- AfsprakenTests, commits en huisstijl los
- Na afloopIngerichte werkplek en checklist
Checklist
Wat we bij de start regelen
- Werk vanaf het eerste moment openbaar en volledig op basis van opensourcecomponenten.
- Bepaal de governance: van wie is de werkplek en wie heeft welke rol. Bijvoorbeeld: de opdrachtgever is eigenaar van de codebase, geeft die (leeg) vrij onder licentie en geeft de opdrachtnemer opdracht om eraan te werken door middel van bijdragen.
- Bepaal de werkplek (GitHub, GitLab of anders) en richt daar een repository in.
- Maak een LICENSE aan in de repository (EUPL 1.2).
- Maak een openbare README met de functionele titel van het project.
- Beschrijf in de README de opdracht en de achterliggende vraag.
- Neem in de README de links op naar het beleid waaruit de opdracht is ontstaan.
- Beschrijf in de README de ambitie op het gebied van opensourcewerken en de huidige status.
- Beschrijf in de README de instructies voor developers, of verwijs ernaar.
- Maak een publiccode.yml aan.
- Maak een GLOSSARY aan voor termen en definities.
- Maak een STANDARDS aan voor de gebruikte standaarden.
- Maak een CONTRIBUTING aan voor bijdragen. Beschrijf daarin ook de verwachtingen, bijvoorbeeld over het gebruik van AI.
- Beschrijf in commit messages waarom je iets wijzigt. Wat er gewijzigd is, staat al in de diff.
- Werk vanaf het begin met geautomatiseerde tests en een hoge code coverage.
- Laat de code coverage bij elke bijdrage minstens gelijk blijven.
- Houd organisatiespecifieke vormgeving (kleuren, logo, namen, fonts) los van de rest van de codebase, bijvoorbeeld in configuratie en losse CSS.
Praktisch
- Duur
- Eén dag, plus een intake vooraf
- Deelnemers
- In overleg, meestal opdrachtgever, opdrachtnemer en het ontwikkelteam
- Locatie
- Bij jou op kantoor of wij regelen de locatie
- Investering
- Vraag om offerte
Waarom Tiltshift
Doe het met Tiltshift
Tiltshift organiseert en begeleidt workshops en projecten in publieke digitalisering. We beginnen bij de mensen en hun werk, niet bij de techniek. Soms is minder techniek het beste antwoord, en dan zeggen we dat ook.
Contact
Zullen we samen goed beginnen?
We beginnen met een korte intake: samen kijken we of de Publieke Code Kick-off past bij jouw vraag. Daarna krijg je een vrijblijvende offerte.
Johan Groenen
Crazy 8's-workshop
Je team schetst ideeën en werkt de beste samen uit. Aan het eind ligt er een concept waar iedereen achter staat. Eén dag.
Bekijk workshopPublieke Code Kick-offEén dag · Vraag om offerte
Boek deze workshop