Standaard voor Publieke Code

Leidraad voor publieke organisaties die willen samenwerken aan open source-oplossingen met soortgelijke organisaties elders.

16 criteria voor publieke code

Criterium 1

Programmeer in het openbaar

Zijn plannen en code publiek toegankelijk?
Dit draagt bij aan transparantie, kwaliteit, controleerbaarheid en samenwerking.

Criterium 2

Bundel beleid en broncode

Zo is het gemakkelijker om te begrijpen hoe de code werkt en waarom het is zoals het is.

Criterium 3

Maak de codebase herbruikbaar

Codebases die door meerdere partijen worden ontwikkeld en gebruikt, hebben meer kans op een langlevende community.

Criterium 4

Verwelkom bijdragers

Verwelkom bijdragers om de community te laten groeien en zichzelf langdurig in stand te houden.

Criterium 5

Maak bijdragen gemakkelijk

Vergroot de kans dat gebruikers bijdragen leveren aan de codebase.

Criterium 6

Houd versiebeheer bij

Dit stelt ontwikkelaars in staat om parallel aan bijdragen te werken en helpt toekomstige ontwikkelaars om de redenen voor wijzigingen te begrijpen.

Criterium 7

Vereis inspectie van bijdragen

Stimuleer een cultuur waarin ervoor wordt gezorgd dat elke bijdrage van hoge kwaliteit, volledig en van waarde is.

Criterium 8

Documenteer de doelstellingen

Dit helpt belanghebbenden en bijdragers de ontwikkeling van de codebase af te kaderen.

Criterium 9

Documenteer de code

Onmisbaar voor mensen om de codebase te gaan gebruiken en eraan bij te dragen.

Criterium 10

Gebruik eenvoudig Engels

Duidelijke en eenvoudige taal zorgt ervoor dat de code en wat deze doet voor een breder publiek begrijpelijk is.

Criterium 11

Gebruik open standaarden

Gebruik open standaarden om interoperabiliteit te garanderen en vendor lock-ins te verminderen.

Criterium 12

Test regelmatig op conflicten

Verzeker je ervan dat bijdragen werken zoals bedoeld en geen fouten bevatten.

Criterium 13

Publiceer met een open licentie

Door voor elk bestand in een codebase duidelijk de licentie aan te geven, worden hergebruik van delen van de codebase en naamsvermelding daarbij eenvoudiger.

Criterium 14

Maak de codebase vindbaar

Onvindbare codebases bestaan de facto niet.

Criterium 15

Gebruik een coherente stijl

Gebruik een coherente stijl om bijdragers in verschillende omgevingen samen te laten werken.

Criterium 16

Beschrijf de volwassenheid

Zo kunnen anderen beslissen of ze de codebase willen gebruiken en eraan willen bijdragen.