Lesen Sie die relevanten Entwicklungsrichtlinien, bevor Sie mit Ihrer Aufgabe beginnen.
Führen Sie diese Schritte aus:
-
Lesen Sie die aktuellen Aufgabenartefakte:
prd.mdfür Anforderungen und Abnahmekriteriendesign.mdfalls vorhanden für das technische Designimplement.mdfalls vorhanden für die Ausführungsreihenfolge und den Validierungsplan
-
Entdecken Sie Pakete und deren Spezifikationsebenen:
python3 ./.trellis/scripts/get_context.py --mode packages -
Identifizieren Sie, welche Spezifikationen für Ihre Aufgabe gelten, basierend auf:
- Welches Paket Sie ändern (z. B.
cli/,docs-site/) - Welche Art von Arbeit (Backend, Frontend, Unit-Test, Dokumentation usw.)
- Eventuelle Spezifikations-/Forschungspfade, auf die die Aufgabenartefakte verweisen
- Welches Paket Sie ändern (z. B.
-
Lesen Sie den Spezifikationsindex für jedes relevante Modul:
cat .trellis/spec/<paket>/<ebene>/index.mdFolgen Sie dem Abschnitt "Checkliste für die Vorentwicklung" im Index.
-
Lesen Sie die spezifischen Richtliniendateien, die in der Checkliste für die Vorentwicklung aufgeführt sind und für Ihre Aufgabe relevant sind. Der Index ist NICHT das Ziel – er verweist Sie auf die tatsächlichen Richtliniendateien (z. B.
error-handling.md,conventions.md,mock-strategies.md). Lesen Sie diese Dateien, um die Codierungsstandards und -muster zu verstehen. -
Lesen Sie immer die gemeinsamen Anleitungen:
cat .trellis/spec/guides/index.md -
Geben Sie für eine nicht-triviale Aufgabe den Änderungsbereich an, bevor Sie Code schreiben. Nicht-trivial bedeutet, dass sie mehr als eine Datei betrifft, eine Ebene überschreitet, eine öffentliche Schnittstelle ändert oder Code bearbeitet, den Sie nicht gerade geschrieben haben. Notieren Sie:
- die kleinste Verhaltenslücke zwischen dem, was jetzt passiert, und dem, was passieren soll
- wo dieses Verhalten tatsächlich lebt (nicht wo es am einfachsten abzufangen ist)
- welche Dateien Sie voraussichtlich ändern werden und warum jede einzelne notwendig ist
- was Sie in dieser Aufgabe ausdrücklich nicht tun
- falls eine lokale Refaktorisierung erforderlich ist, wie Sie zeigen werden, dass sie das Verhalten nicht geändert hat
Eine kleine, gut abgegrenzte Änderung benötigt dies nicht – führen Sie sie direkt aus.
Wenn sich herausstellt, dass der tatsächliche Umfang eindeutig größer ist als dieser, sagen Sie dies und begründen Sie es, bevor Sie fortfahren. Erweitern Sie den Umfang nicht eigenmächtig.
-
Verstehen Sie die Codierungsstandards und -muster, die Sie befolgen müssen, und fahren Sie dann mit Ihrem Entwicklungsplan fort.
Dieser Schritt ist obligatorisch, bevor Sie Code schreiben.