Introductie​

Om te beginnen, hartelijk dank voor je interesse om bij te dragen aan ons gezamenlijke Developer Portal voor de hele Nederlandse overheid! Door onze ervaringen te delen, helpen we anderen om beter onderbouwde keuzes te maken. Omdat wij willen voorkomen dat we standaarden of projecten uit specifieke organisaties een voorkeursbehandeling geven, ontvangen we graag thema's en documentatie van zoveel mogelijk organisaties binnen de overheid.

Dit portaal​

Software bouwen voor de overheid brengt specifieke uitdagingen met zich mee. Dit portaal helpt je om te voldoen aan overheidspecifieke eisen, zoals securitystandaarden en toegankelijkheidsrichtlijnen. Daarnaast vind je hier informatie over beschikbare Open Source-projecten en hoe je deze kunt inzetten.

Hoe je kunt bijdragen​

Alle artikelen in onze kennisbank zijn geschreven in de .md of .mdx extensie en dus eenvoudig aan te passen.

Je kunt bijdragen op de volgende manieren:

• Dien een issue in

  Heb je een idee voor een artikel of feature? Of heb je een bug gevonden? Dien een issue in op onze Github.

• Schrijf een gastblog

  Het schrijven van een gastblog is een effectieve manier om je kennis te delen met de community.

• Kennisbankartikel toevoegen

  Heb jij een tutorial of artikel die je graag wilt toevoegen aan onze kennisbank?

• API toevoegen

  Heb jij een nuttige API in je organisatie? Voeg deze toe aan het API-register.

• Repository toevoegen

  Heb jij waardevolle repositories? Voeg deze toe aan het Open Source Software-register.

• Naar onze Slack

  Heb je een inhoudelijke vraag over onze tools of standaarden? Stel deze in onze Slack-groep.

• Volg ons op Mastodon

  Wil je in gesprek met andere developers en ons? Volg ons op Mastodon.

• Volg ons op LinkedIn

  Op de hoogte blijven van de laatste ontwikkelingen? Volg ons op LinkedIn.

Labels voor issues​

Om issues beter te organiseren, gebruiken we labels. Voeg bij het indienen van een issue een passend label toe, zodat het sneller de juiste aandacht krijgt:

• content → Voor voorstellen of wijzigingen aan artikelen.
• bug → Voor het melden van fouten of problemen.
• ux → Voor ideeën en verbeteringen rondom design, gebruikerservaring en toegankelijkheid.
• enhancement → Voor het voorstellen van nieuwe features of verbeteringen aan bestaande functionaliteit.

Een volledig overzicht van beschikbare labels vind je in onze GitHub repository.

Voordat je begint​

Voor je aan de gang gaat zouden we je willen vragen de volgende punten af te vinken:

• Heeft iemand anders al eens een soortgelijk issue ingediend? Check dit in de backlog.
• Ben je van plan zelf een feature te bouwen? Neem dan om af te stemmen eerst contact met ons op via Slack of e-mail.

Coderichtlijnen​

Op dit moment hanteren we in onze codebases (nog) geen strikte voorschriften mbt het opleveren van code. We gaan er vanuit dat als iets met zorg is gebouwd er goed is nagedacht over de opzet en de schrijfwijze. Mocht je vragen hebben over hoe je iets dient op te leveren dan kun je je vraag stellen in ons Slackkanaal.

Aanbieden pull request​

Wanneer je pull request wordt gemerged in de main branch, squashen we alle commits tot één commit met een passende naam. Je hoeft je dus niet druk te maken dat de namen van je commits allemaal even eloquent hoeven te zijn.

Opzetten ontwikkelomgeving​

Check onze README.md.

Gedragscode​

Check onze CODE_OF_CONDUCT.md.

Juridisch​

Dit project heeft een EUPL (European Union Public License) licentie. Dit betekent dat de volgende punten van toepassing zijn op je bijdrage:

1. Je bijdrage valt automatisch onder de EUPL. De EUPL bevat een copyleft-bepaling, wat betekent dat alle afgeleide werken ook onder de EUPL (of een compatibele licentie) moeten blijven. Dit voorkomt dat je bijdrage later wordt omgezet naar een gesloten, propriëtair product.

2. Je behoudt het auteursrecht op je code. Jij blijft juridisch eigenaar van je eigen bijdrage. Maar door bij te dragen, geef je anderen het recht om jouw code te gebruiken, wijzigen en verspreiden onder de voorwaarden van de EUPL.

3. Iedereen mag je code gebruiken en aanpassen. De EUPL staat toe dat anderen jouw code kopiëren, verspreiden en aanpassen, zolang ze zich aan de licentievoorwaarden houden. Dit betekent ook dat verbeteringen en aanpassingen aan jouw code weer terug kunnen vloeien in de community.

4. Compatibiliteit met andere licenties. De EUPL is compatibel met een aantal andere open source-licenties, zoals de GPL en de MPL. Dit betekent dat jouw code onder bepaalde voorwaarden ook in projecten met die licenties kan worden gebruikt.

5. Je hebt recht op erkenning. De licentie vereist dat jouw auteurschap erkend blijft. Anderen mogen je code dus niet zomaar zonder naamsvermelding overnemen.

Als je jezelf, nadat je een bijdrage hebt gedaan, wilt vereeuwigen in onze codebase nodigen we je uit om jezelf aan onze AUTHORS.md toe te voegen.

Bestuur​

Voor meer informatie over de financiering en organisatie van dit project, zie onze GOVERNANCE.md.

Contact​

Check onze README.md onder het kopje contact.