okx-public-governance

Instruction file imported from Npuls-OKx/Public (.cursor/rules/okx-public-governance.mdc). Copyright stays with the author.

Dit is Public source van OKx (Onderwijskoppelingen): de publieke bron van de releaseartefacten. Het is geen kennisbasis en geen werkomgeving. Wat hier staat wordt gepubliceerd en door instellingen en leveranciers gebruikt om koppelvlakken te bouwen.

Het onderscheid met de andere repositories bepaalt wat hier wel en niet thuishoort:

Werk rijpt in meta en komt hierheen zodra het releasebaar is. Materiaal dat nog in beweging is hoort niet hier.

Branchmodel

feature/...  ->  dev  ->  release branch N      (actuele major)
                     ->  release branch N-1     (alleen minor en patch)

• Werk altijd op een feature/...-branch, getakt vanaf dev.
• Pull requests gaan naar dev. Nooit rechtstreeks committen op dev of op een release branch.
• Release branch N draagt de actuele major en ontvangt alles uit dev; N-1 draagt de vorige major en ontvangt daaruit alleen minor- en patchwijzigingen.
• Een releasepakket krijgt een versielabel vMAJOR.MINOR.PATCH volgens SemVer.

Governance

• Iedereen mag issues openen en pull requests indienen; alleen het verantwoordelijke OKx-team merget.
• Koppel een pull request aan het issue dat eraan ten grondslag ligt (Fixes #..., See also #...). Dat geldt voor de pull request en de commit message, niet voor de documenten zelf: zie de regel over gereleasde documenten.
• Is een wijziging een architectuurbesluit, leg het dan vast als ADR in Referentiemateriaal/adr/, niet als losse tekst in een specificatie. De besluiten leven hier, niet meer in meta.

Noem altijd de repository

OKx werkt met twee repositories die elk hun eigen nummering hebben voor issues en pull requests. Nummers overlappen dus, en beide hebben een dev. Issue 1 in Npuls-OKx/Public is iets heel anders dan issue 1 in Npuls-OKx/meta.

Noem daarom bij elke branch, pull request of issue expliciet om welke repository het gaat, in rapportage aan een mens net zo goed als in een pull request-beschrijving of commit message:

goed:  PR #7 in Npuls-OKx/Public   ·   Npuls-OKx/meta#82   ·   `feature/adr-naar-public` in Npuls-OKx/Public
fout:  PR #7   ·   #82   ·   de dev-branch

Bij de eerste vermelding voluit; daarna mag de korte vorm zolang er geen verwarring kan ontstaan. Een cross-repo issueverwijzing in een commit of pull request schrijf je altijd volledig gekwalificeerd, want GitHub linkt hem anders naar het verkeerde nummer in de eigen repository.

Entrypoint

CLAUDE.md in de root is het startpunt voor een agent; AGENTS.md is een symlink daarheen. Rules komen automatisch mee, commands start je met /, en de skills staan in .agents/skills/ met shims op .claude/skills en .cursor/skills zodat beide tools ze vinden.

Voordat je iets voorstelt

Draai vanuit de repo-root:

python3 scripts/check-links.py        # dode links, ontsnappingen, dode anchors
python3 scripts/check-conventies.py   # issueverwijzingen, metadatakoppen, branchlinks
python3 scripts/json-tree.py --check <document>.md   # payload-documenten