Skip to content

Contributing ​

Bijdragen aan ERP-NL horen klein, toetsbaar en passend bij de bestaande structuur te zijn.

Werkwijze ​

  1. Maak een branch vanaf main.
  2. Houd wijzigingen beperkt tot het onderwerp van de issue of PR.
  3. Volg bestaande patronen in backend/, frontend/, shared/, scripts/ en docs/.
  4. Voeg tests toe waar gedrag verandert.
  5. Draai relevante checks lokaal.
  6. Beschrijf in de PR wat is gewijzigd en wat bewust buiten scope blijft.

Codekwaliteit ​

Gebruik bestaande quality scripts waar mogelijk:

bash
npm run lint
npm run quality:all
npm run build
pytest -q tests/backend

Voor documentatie:

bash
npm run docs:build

Documentatie ​

Nieuwe functionele of technische mogelijkheden horen waar nodig documentatie te krijgen. Bestaande generated docs onder docs/generated worden alleen aangepast wanneer de docgen-output bewust wordt vernieuwd.

Pull requests ​

Een goede PR bevat:

  • een korte samenvatting;
  • relevante testresultaten;
  • eventuele migratie- of deploymentnotities;
  • expliciete vermelding van bekende beperkingen.