docs / contributing

Meebouwen

De engine is nog niet publiek, dus deze pagina beschrijft hoe bijdragen werken zodra hij opengaat, niet hoe je vandaag een PR indient. Een paar conventies houden de bijdrage-loop straks soepel.

Waar te beginnen

  • CLAUDE.md in de repo voor de developer-guide (architectuur, conventies, huidige staat)
  • docs/VISION.md voor de product-filosofie
  • tests/ directory voor ~500 tests die het beoogde gedrag demonstreren

De workflow

  1. Fork de repo, branch af van main.
  2. Schrijf eerst een falende test wanneer de wijziging gedrag-gebaseerd is. Soriku volgt RCT-disciplines (Red, Commit, Green).
  3. Houd de PR focused: één feature of fix per PR, geen grab bag.
  4. Draai python -m pytest tests/ -v voor je pusht.
  5. Open de PR met het test plan in de beschrijving.

Engineering-principes

  • RCT discipline: falende test eerst, kleinst mogelijke commit, dan groen maken
  • Determinisme boven cleverness: de router en benchmarks moeten reproduceerbaar zijn
  • Gemeten, niet geclaimd: capability-wijzigingen vereisen benchmark-bewijs
  • Lokaal-eerst: features die alleen in cloud-mode werken gaan achter een heldere feature gate
  • Eerlijkheid in errors: slik exceptions niet, surface root causes
  • Compacte diffs: kleine PRs reviewen en mergen sneller

Deze docs verbeteren

De docs op deze site zijn handgeschreven en worden bijgewerkt op basis van de interne referentiematerie van de engine (API-oppervlak, persona-definities, config-schema) zodra die verandert.

Security-issues

Open geen publieke issues voor security-vulnerabilities. Mail security@atypisch.nl. Gecoördineerde disclosure binnen 90 dagen.