Bijdragen

Het project wordt beter met jou erbij.

beatrax wordt in het openbaar gebouwd onder een licentie met ethische gebruiksclausules. Je kunt elke regel lezen, het zelf draaien en het aanpassen. Deze pagina vertelt wat je concreet doet — de regels hieronder komen rechtstreeks uit de specificatie, dus het zijn dezelfde regels die een reviewer toepast.

Vier manieren om in te stappen, oplopend in moeite.

Niet elke waardevolle bijdrage is code. De eerste op deze lijst is wat het product het hardst nodig heeft en vraagt geen enkele lokale installatie.

  1. 01

    Vul de gemeenschapscorpus aan

    Simpele YAML die de cryptische omschrijvingen van je bank koppelt aan namen die mensen herkennen. Geen code, geen toolchain, geen installatie — één bestand per land, in de browser te bewerken.

    Hoe de corpus werkt →
  2. 02

    Meld wat er misging

    Een afschrift dat verkeerd inleest, een totaal dat niet klopt, een scherm dat op je telefoon rare dingen doet. Beschrijf de vorm van het probleem; stuur nooit een echt afschrift mee.

    Open een issue →
  3. 03

    Wijzig de specificatie

    Gedrag wordt gespecificeerd voordat het geschreven wordt. Wil je dat beatrax iets anders doet, dan landt de specificatiewijziging eerst en verwijst de code ernaar.

    Lees het wijzigingsproces →
  4. 04

    Schrijf de code

    Pak openstaand werk op of breng je eigen idee mee. Bij grote wijzigingen loont het om vooraf de vorm af te stemmen — dat is goedkoper dan achteraf herbouwen.

    Lees de bijdragegids →

Openstaand werk, op dit moment.

Alles binnen de organisatie dat nu gelabeld staat voor nieuwkomers. Deze lijst is de live issue-zoekopdracht, geen handmatig bijgehouden kopie.

Er staat op dit moment niets gelabeld voor nieuwkomers. Bekijk alle open issues

De poorten.

Elke pull request komt hier langs voordat de review begint. Draai ze eerst lokaal — het zijn dezelfde commando's die CI draait.

Formatting

the standard preset.

Static analysis

maximum level, strict mode.

Tests

the full suite including architecture tests. Run them locally first. Local hooks run the cheap ones automatically.

De afspraken die afgedwongen worden.

Dit zijn geen reviewvoorkeuren. Ze worden door tests gecontroleerd, dus een wijziging die er één breekt laat de build falen in plaats van een opmerking op te leveren.

  • Dependency injection onlyNo global accessors in module code (ADR-0002).
  • The module boundaryImport another module's public surface or its models, never its interior.
  • No floating-point moneyAnywhere on the money path.
  • The comment policyMechanical rules are tested.
  • Sanctioned writersOne write path per shared column.
  • Cross-user testsEvery user-scoped surface gets one.

Wat verder het lezen waard is.

De specificatie is leidend voor hoe beatrax zich gedraagt — boven deze website en boven elke README.