Elke run begint met wat CodeLynq al over je codebase weet: waar dingen staan, welke conventies je volgt, welke beslissingen je hebt genomen en welke valkuilen je moet vermijden. Dit geheugen groeit vanzelf naarmate runs leren, en je kunt er zelf aan toevoegen.
Waar de kennis vandaan komt
Elke run leest, in deze volgorde:
- Standaarden van de organisatie - regels voor elk project in de organisatie.
- Projectgeheugen - feiten die voor het hele project gelden.
- Repositorygeheugen - feiten over één specifieke repository.
Samen met de context en conventies van het project is dit wat een run weet voordat hij code schrijft.
Hoe het geheugen groeit
Na een run legt CodeLynq nieuwe, blijvende feiten vast die het over de codebase heeft geleerd - bijvoorbeeld dat een bepaalde map alle API-handlers bevat, of dat de tests een speciale opzet nodig hebben. Ook feedback van reviewers op pull requests is een bron. Deze items zijn gemarkeerd als geleerd. Geleerde items kunnen na verloop van tijd automatisch worden opgeschoond; notities die je zelf toevoegt, blijven bewaard.
Het geheugen bekijken en aanpassen
Open het project en ga naar Instellingen → Geheugen. De items zijn gegroepeerd onder Hele project en per repository. Bij elk item zie je de soort - structuur, conventie, valkuil, beslissing of overig - en of het vastgezet is (door een mens toegevoegd) of geleerd.
Beheerders van de organisatie en de eigenaar van het project kunnen:
- Notitie toevoegen - kies de Soort, het Bereik (Hele project (alle repositories) of één repository) en schrijf de Inhoud, en klik op Notitie toevoegen. Notities die je toevoegt zijn vastgezet en worden nooit automatisch verwijderd.
- Elk item Bewerken of Verwijderen - bijvoorbeeld een geleerd feit dat niet klopt of niet meer geldt.
Schrijf een notitie zo dat hij op zichzelf te begrijpen is, bijvoorbeeld: "Auth-tokens worden gevalideerd in app/core/security.py - doe die controle nooit nog eens in handlers."
Standaarden van de organisatie
Regels die voor elk project moeten gelden - de dingen die je anders in elke code review herhaalt - horen bij de standaarden van de organisatie.
- Ga naar Instellingen (onder Organisatie in de zijbalk) → Standaarden.
- Klik op Regel toevoegen, kies een soort (Conventie, Beslissing, Valkuil, Structuur of Overig) en schrijf de regel in een of twee zinnen.
- Sla hem op. Elke regel kun je later bewerken of verwijderen.
Alleen beheerders van de organisatie kunnen standaarden toevoegen, bewerken of verwijderen; andere leden kunnen ze lezen. Elke regel gaat met elke run mee, dus de lijst heeft een maximale lengte - voeg verwante regels samen om hem gericht te houden.
Tips
- Verbeter verkeerde feiten zodra je ze ziet: een fout in het geheugen werkt door in elke volgende run.
- Gebruik het geheugen voor feiten over de code; zet wat alleen voor één klus geldt in de taak of de specificatie.
- Standaarden van de organisatie passen bij regels voor alle projecten ("elk endpoint schrijft een auditlogregel"); de projectcontext past bij de stack en architectuur van één project.