Skip to content

Rulebook-lessen goedkeuren ​

Reviews leren soms een les die in een rulebook thuishoort. Spexso verzamelt die lessen in één inbox per project. Jij beslist welke een regel worden.

Hoe een les in de inbox komt ​

  1. /spexso-review vindt een systemische fout en stelt hoogstens één regel voor. Dat gebeurt alleen als de les een critical/high-bevinding ondersteunt, geen namen uit jouw code bevat en nog niet in een rulebook staat.
  2. Een voorstel dat overeenkomt met een eerder afgewezen les, valt meteen weg.
  3. Pilot/copilot: je krijgt het voorstel als diff en kiest toepassen, aanpassen of afwijzen.
  4. Yolo: het voorstel komt in het issue [rulebook-inbox]. Dezelfde les nog eens gevonden? Dan krijgt de bestaande entry een extra vermelding (seen 2× — #12, #19) in plaats van een nieuw ticket. Vanaf twee keer staat ze onder ## Ready.
  5. Zodra er iets klaarstaat, eindigt elke review en elke marathon met:
    📥 3 rulebook lesson(s) ready (#57) → /spexso-rulebook

Beslissen met /spexso-rulebook ​

  1. Draai /spexso-rulebook in je project. Met --all komen ook de lessen mee die maar één keer gezien zijn.
  2. Kies één voor één of alle klaar-lessen ineens goedkeuren.
  3. Eén voor één zie je per les een diff en kies je toepassen, aanpassen, afwijzen of overslaan.
  4. Spexso zet de goedgekeurde regels in .spexso/rules/{domain}.local.md op een nieuwe branch spexso/rulebook-<stamp>, met één commit per regel, en opent een merge request. Die MR merge je zelf, via de gewone review.
  5. De inbox wordt bijgewerkt: toegepaste lessen verdwijnen, afgewezen lessen gaan naar ## Rejected, en overgeslagen lessen blijven staan.

Of: rechtstreeks in GitLab ​

In het inbox-issueGevolg
Vink een les aanGoedgekeurd. De volgende /spexso-rulebook past ze toe zonder te vragen.
Pas de tekst aan en vink aanGoedgekeurd met jouw formulering
Verplaats een les naar ## RejectedAfgewezen. Ze komt nooit meer terug.
Verwijder een lesWeg, maar ze kan terugkomen als een review ze opnieuw vindt

Afwijzen = verplaatsen, niet verwijderen

## Rejected is het geheugen van de inbox. Een les die je gewoon wist, stelt een volgende review misschien opnieuw voor.

Oude [rulebook-lesson]-issues ​

Oudere versies maakten per les een apart issue [rulebook-lesson] aan. De eerste keer dat je /spexso-rulebook draait, ruimt het die op:

  1. Elk oud issue gaat door dezelfde drempel als een nieuwe review. Lessen met namen uit je code, algemene kennis of regels die al bestaan vallen af. Gaten in Spexso zelf worden als [spexso] gemarkeerd.
  2. De rest gaat de inbox in. Dubbele lessen tellen als vermeldingen, dus drie tickets over dezelfde regel worden één entry seen 3×.
  3. Je ziet eerst het plan, bijvoorbeeld 6 → inbox, 15 → drop, 3 → [spexso], en kunt de details per issue bekijken.
  4. Pas na je bevestiging sluit Spexso de oude issues, elk met een note waar ze naartoe gingen of waarom ze afvielen.

Tips ​

  • Lessen met [spexso] zijn geen projectregels, maar gaten in Spexso zelf. /spexso-rulebook stelt voor ze te melden met /spexso-feedback.
  • Lessen met [stack] gelden voor elk CAP/UI5/ABAP-project. Ook die zijn de moeite om te melden: ze kunnen in de rulebooks komen die Spexso standaard meelevert.
  • Zie Rulebook promotion voor het volledige ontwerp.