12. Repositories op GitHub

Date: 2026-01-14

Status

Proposed

Context

Het project Mijn Overheid Zakelijk (MOZa) zal bestaan uit verschillende repositories. Deze worden conform beleid publiek beschikbaar gemaakt.

Decision

Het Ministerie van Binnenlandse Zaken en Koninkrijksrelaties heeft hiervoor een GitHub‑organisatie gemaakt MinBZK. Hieronder worden alle repositories van MOZa geplaatst met prefix "moza-" en topic mijnoverheidzakelijk.

Consequences

Er zijn een reeks richtlijnen voor publieke open source projecten, vanuit publieke organisaties.

Open Source richtlijnen

Projecten op GitHub worden vergeleken met Open Source standaarden. Elk project heeft hier ook een checklist pagina voor binnen GitHub, te vinden op https://github.com/MinBZK/<Projectnaam>/community.

developer.overheid.nl heeft hier ook handleidingen voor opgesteld op basis van de standaard voor publieke code.

Standaard richtlijnen vanuit MinBZK

Standaard krijgt elke repository richtlijnen mee vanuit de MinBZK organisatie. Deze worden beschikbaar gemaakt op de pagina's op GitHub van de repository. Dit gaat om:

  • Code of conduct, richtlijnen voor samenwerking in het project.
  • Contributing, richtlijnen over hoe bijgedragen kan worden.
  • Security, richtlijnen over hoe met security omgegaan wordt.

Controleer of deze richtlijnen toepasselijk en volledig zijn. Mocht dit niet zo zijn, dan kan er een eigen bestand in de hoofdfolder geplaatst worden, respectievelijk genaamd CODE_OF_CONDUCT.md, CONTRIBUTING.md en SECURITY.md.

GitHub Community Standards checklist

Om aan de checklist op Github te voldoen zijn de volgende bestanden nodig:

  • Introductie in bestand README.md. Hierin wordt een korte samenvatting van het project gegeven met relevante extra informatie. Zie de handleiding bij developer.overheid.nl
    • Overweeg om de status van het project aan te geven met shields.io. Bijvoorbeeld
      • Project Pre-Alpha Status Project Alpha Status Project Beta Status Project Production Status
      • GitHub Licence
      • GitHub Actions Workflow Status
  • Licentieverklaring in bestand LICENSE of LICENSE.md. Kies een licentie en plaats die in dit bestand. Meestal is EUPL-1.2 passend. Wanneer de Engelse versie geplaatst wordt, herkent GitHub deze en wordt deze direct als titel afgebeeld. Wanneer de Nederlandse versie geplaatst wordt, is de titel 'License' en moet doorgeklikt worden om de licentie te bepalen.
  • Issue templates. GitHub heeft voorbeeld templates voor Bugs, Features en Custom templates. Dit kan helpen om de juiste informatie in issues te krijgen. Zie About issue and pull request templates
  • Pull Request template. Dit helpt om te zorgen dat de juiste informatie toegevoegd wordt en standaard checks uitgevoerd worden voor het mergen. Zie Creating a pull request template for your repository

Mogelijke toevoegingen

Daarnaast is het mogelijk om hier enkele toevoegingen op te doen. Ga na of deze nodig zijn of niet.

  • Governance met GOVERNANCE.md. Hierin kan beschreven worden hoe besluiten genomen worden in het project, bijvoorbeeld over hoe product- en technische keuzes gemaakt worden. Voorbeeld zijn o.a. te vinden bij Public Code, toegepast en vertaald in Mijn Bureau, of OSPO-NL.
  • Support met SUPPORT.md. Hier kan beschreven worden hoe gebruikers ondersteuning kunnen krijgen vanuit het project. Zie Adding support resources to your project
  • Toevoeging open source softwarecatalogi bestand met publiccode.yml. Hier is een tool voor, of deze kan via een template opgesteld worden.

Security

De volgende zaken zijn goed om aan publieke open source projecten toe te voegen: