Om inzichtelijk te maken wat de code van een open source project precies doet is het nodig dat er ergens metadata over het project beschikbaar is. Hiervoor is de publiccode.yml standaard in het leven geroepen. Deze standaard heeft twee belangrijke doelen:
- Open source projecten vindbaar maken
- Informatie over een open source project centraliseren
Vindbaarheid
De publiccode.yml standaard zorgt op een eenvoudige manier voor vindbaarheid. Op het momet dat een codebase een publiccode.yml bestand bevat in de root van het project, kan het project worden gemarkeerd als een open source project. Bots kunnen op die manier makkelijk platforms als Gitlab en Github afstruinen op zoek naar projecten met een publiccode.yml bestand.
publiccode.yml generator
Er is een tool beschikbaar voor het genereren van een publiccode.yml. Deze vind je hier:
In de toekomst zou het zeer nuttig zijn als er ook een Nederlandstalige versie van deze tool beschikbaar komt. Wil je daar samen met ons aan werken? Neem dan contact met ons op.
Examples
Als voorbeeld kan je de publiccode.yml gebruiken van Developer Overheid:
publiccode.ymlvan Developer Overheid
Andere goede voorbeelden zijn:
publiccode.ymlvoorbeelden uit de documentatie van depubliccode.ymlstandaardpubliccode.ymlvan Open Zaak
publiccode.yml standaard
De standaard achter publiccode.yml is constant in ontwikkeling. Voor de mensen achter de standaard is het fijn als wij als developers input leveren om de standaard te kunnen verbeteren. Je kan input leveren door het aanmaken van een issue op de Github pagina van de standaard.
Andere belangrijke links met betrekking tot de standaard:
- De documentatie van de standaard
- De documentatie van het
publiccode.ymlschema