Mitarbeit an der Starlight Dokumentation

Um an der Starlight-Dokumentation auf GitHub mitzuarbeiten, können Sie sich der offenen Community anschließen und Ihre Expertise und Beiträge zur Weiterentwicklung der Dokumentation einbringen.

Voraussetzungen

1. GitHub-Konto: Sie benötigen ein aktives GitHub-Konto, um Änderungen vorzunehmen und Pull-Requests zu erstellen.
2. Grundkenntnisse in Markdown: Die Dokumentation wird hauptsächlich im Markdown-Format geschrieben. Ein grundlegendes Verständnis von Markdown-Syntax ist hilfreich.

Schritte zur Mitarbeit

1. Repository klonen: Klonen Sie das Starlight-Dokumentations-Repository von GitHub.

   git clone https://github.com/vonReyher-media/sitzplan_digital_docs
   cd sitzplan_digital_docs

2. Branch erstellen: Erstellen Sie einen neuen Branch für Ihre Änderungen.

   git checkout -b neuer-branch-name

3. Änderungen vornehmen: Bearbeiten Sie die Dokumentationsdateien im docs/-Verzeichnis. Fügen Sie neue Inhalte hinzu, aktualisieren Sie bestehende Anweisungen oder korrigieren Sie Fehler.
4. Commit und Push: Speichern Sie Ihre Änderungen und pushen Sie den neuen Branch zu Ihrem GitHub-Repository.

   git add .
   git commit -m "Kurzbeschreibung der Änderungen"
   git push origin neuer-branch-name

5. Pull-Request erstellen: Wechseln Sie zu Ihrem GitHub-Repository und erstellen Sie einen Pull-Request, um Ihre Änderungen zur Überprüfung vorzuschlagen.

Empfehlungen zur Mitarbeit

• Feedback: Kommentieren und unterstützen Sie andere Mitwirkende, indem Sie Feedback zu Pull-Requests geben oder Verbesserungen vorschlagen.
• Code-Qualität: Achten Sie auf klar strukturierte und gut dokumentierte Beiträge, die den Code-Stil und die Standards der Starlight-Dokumentation einhalten.
• Community-Beteiligung: Diskutieren Sie im GitHub-Repository oder auf Community-Foren, um über neue Features, Bugs oder allgemeine Verbesserungen zu informieren.

Indem Sie an der Starlight-Dokumentation mitwirken, tragen Sie aktiv zur Weiterentwicklung und Qualität der Inhalte bei.