Entwicklungsablauf
Projekt starten
Anforderungen verstehen und Code schreiben
Das ist ein komplexer Prozess, aber normalerweise geht es um drei Dinge:
- Eingabe klären:
vseed - Ausgabe klären:
vseedwird zuadvancedVSeed, oderadvancedVSeedwird zuspec - Code schreiben und sicherstellen, dass neue Eingaben die erwarteten Ausgaben erzeugen
Der playground (apps/website/docs/de-DE/playground/index.mdx) kann für Debugging und Entwicklung verwendet werden.
Neue Testfälle erstellen
Falls nötig, können neue Testfälle erstellt werden.
Wenn die Testabdeckung sinkt, müssen neue Testfälle erstellt werden.
Erstellen Sie im Verzeichnis packages/vseed/tests/* eine neue Datei testName.json und schreiben Sie die VSeed DSL hinein.
Ausführen:
Unit-Tests ausführen und Abdeckung aktualisieren
Stellen Sie drei Dinge sicher:
- Alle Tests bestehen
- Snapshot-Änderungen entsprechen den Erwartungen
- Die Abdeckung ist nicht gesunken
Änderungen der Abdeckung werden automatisch in README.md aktualisiert
Konfigurationsdokumentation aktualisieren
Wenn TypeScript-Definitionen für Charttypen geändert wurden, aktualisieren Sie bitte die Konfigurationsdokumentation.
Alle Typdefinitionen unter packages/vseed/src/types/chartType entsprechen der Konfigurationsdokumentation jedes Charts. Bei Änderungen bitte unbedingt aktualisieren.
Veröffentlichen und einreichen
Nach dem Ausführen von pnpm changeset folgen Sie den Prompts:
- Wählen Sie die zu ändernden Pakete aus; normalerweise nur
vseed - Folgen Sie Semantic Versioning und wählen Sie den Änderungstyp. In den meisten Fällen reicht es, zweimal Enter zu drücken,
majorundminorzu überspringen undpatchzu wählen - Geben Sie eine Änderungsbeschreibung ein, z. B.:
fix: chart render error caused by only one measure
Eine Funktion oder ein Bugfix entspricht einem changeset und einem commit
Ein Pull Request entspricht einem issue
Ein Pull Request mit mehreren Funktionen oder Bugfixes entspricht mehreren changesets und mehreren commits