marcus/asv-format-validator
1
0
Fork 0
Code Pull Requests Actions Packages Releases Activity
Files
4299baeec0dd4333781f01432f908cb4b3ea1828
asv-format-validator/skills/asv-small-step/SKILL.md

2.0 KiB
Raw Blame History

name, description, license, metadata
name description license metadata
asv-small-step Verwende diesen Skill, wenn im ASV-Format-Validator ein neuer kleiner fachlicher Spezifikationsschritt umgesetzt werden soll. Der Skill erzwingt minimale Änderungen, Schutz des bestehenden Projektstands, keinen Parser-Umbau und vollständige Tests. Proprietary
project language
asv-format-validator de

ASV Small Step

Zweck

Dieser Skill ist für kleine, klar abgegrenzte Implementierungsschritte im Projekt ASV-Format-Validator gedacht.

Verbindliche Arbeitsweise

  • Implementiere genau eine neue fachliche Regel oder einen eng abgegrenzten Stabilisierungsschritt.
  • Baue strikt auf dem bestehenden Projektstand auf.
  • Kein Parser-Umbau.
  • Keine EDIFACT-Neuinterpretation auf Verdacht.
  • Keine neue Validator-Hierarchie auf Verdacht.
  • Keine Refactorings auf Verdacht.
  • Bestehende Regeln und Tests dürfen nicht semantisch verbogen werden.

Architekturregeln

  • Bevorzuge minimale Ergänzungen in bestehenden Klassen.
  • Für Strukturregeln bevorzuge Ergänzungen im bestehenden DefaultStructureValidator, solange keine ausdrückliche Gegenanweisung vorliegt.
  • Neue Klassen nur dann, wenn technisch zwingend nötig und sehr klein.

Sprach- und Stilregeln

  • Technische Bezeichner auf Englisch.
  • Kommentare, JavaDoc und benutzernahe Fehlermeldungen auf Deutsch.
  • Vollständigen, kompilierbaren Code liefern.

Testregeln

  • Für den neuen Schritt gezielte Tests ergänzen.
  • Testdaten so gestalten, dass sie die neue Regel isoliert prüfen.
  • Keine unnötigen Zusatzfehler in Testressourcen erzeugen.
  • Nach der Umsetzung vollständig testen mit:
    • mvn clean test

Wenn Tests fehlschlagen

  • Nicht nur den ersten Fehler beheben.
  • Alle fehlschlagenden Tests gemeinsam analysieren.
  • Nach gemeinsamer Ursache gruppieren.
  • Alle zugehörigen Korrekturen in einem Durchgang umsetzen.

Ausgabeformat

  1. Ausgeführter Maven-Befehl
  2. Kurzes Testergebnis
  3. Sehr kurze Liste der geänderten Dateien
  4. Vollständiger Code aller tatsächlich geänderten Dateien
  5. Keine langen Erklärungen
View Git Blame Copy Permalink