CONTRIBUTING.md

Contributors' Guide

Vielen Dank, dass du an der Entwicklung der Taktischen Zeichen mitarbeiten möchtest! Diese Anleitung hilft dir hoffentlich dabei.

Voraussetzungen

Du benötigst Node 21. Fertig. Wir empfehlen Volta.

Installation

npm ci
npm run bootstrap

Bauen

npm run build

Lokaler Test

./taktisches-zeichen.sh --grundzeichen fahrzeug --organisation feuerwehr

Schreibt das taktische Zeichen in tz.svg.

Website lokal testen

npm run dev

Öffne http://localhost:8000. Alle Änderungen an Source-Dateien werden automatisch in der Website aktualisisert, das dauert aber ein paar Sekunden.

Pull Requests

Wir verwenden Changesets für unser Changelog und die Versionierung unserer Pakete.

Wenn du einen PR erstellst, füge bitte auch ein Changeset hinzu:

npx changeset

Wähle alle Repositories außer taktische-zeichen-website aus, auch wenn du in nicht in jedem Änderung gemacht hast.

Wähle nun aus, welche Pakete durch deine Änderung einen major oder minor oder patch Versionssprung erhalten sollen.

• major: Die API hat sich so verändert, das bisherige Benutzer nun einen Fehler erhalten werden. Dies ist insbesondere der Fall, wenn du Elemente entfernt hast.
• minor: Du hast neue Elemente oder Funktionen hinzugefügt. Benutzer erhalten keinen Fehler, wenn sie die neue Version einfach aktualisieren.
• patch: Du hast ein bestehendes Element korrigiert oder leicht verändert oder die Beschreibung geändert.

Committe die neu erstellte Datei unter .changeset mit in deinen PR.

Wenn alles gut gelaufen ist, erhälst du automatisch einen Kommentar in deinem PR, welche Packages durch deine Änderung eine neue Version erhalten werden.

Dokumentation

Wenn du ein neues Element hinzufügst oder eines entfernst, aktualisiere bitte die README mit: npm run update-docs.