Leitfaden zur Mitarbeit an der TIDAS-Dokumentation

Beiträge zur TIDAS-Dokumentation sind willkommen. Der Ablauf besteht aus den folgenden Schritten.

1. Projekt forken

• Öffnen Sie das TIDAS-Repository auf GitHub.

• Klicken Sie oben rechts auf „Fork“.

• Wählen Sie Ihr GitHub-Konto als Ziel aus.

2. Repository klonen

git clone https://github.com/YOUR-USERNAME/tidas.git

Je nach lokaler Einrichtung können Sie HTTPS oder SSH verwenden. Für SSH muss ein entsprechender Schlüssel in Ihrem GitHub-Konto hinterlegt sein.

3. Änderungen vornehmen

• Die öffentlichen Dokumentationsquellen liegen unter content/docs/.

• Schreiben Sie Inhalte in Markdown beziehungsweise MDX.

• Halten Sie sich an Struktur und Stil der bestehenden Seiten.

4. Änderungen committen

git add .
git commit -m "Describe your changes"
git push origin your-branch-name

5. Pull Request (PR) erstellen

• Öffnen Sie den Fork in Ihrem GitHub-Konto.

• Klicken Sie auf „Compare & pull request“.

• Beschreiben Sie im PR nachvollziehbar, was und warum geändert wurde.

• Klicken Sie auf „Create pull request“.

6. Review

• Warten Sie auf die Prüfung durch das Maintainer-Team.

• Arbeiten Sie begründetes Feedback in Ihrem Branch ein.

Hinweise für Beiträge

• Formulieren Sie klar und präzise.

• Beachten Sie die bestehende Formatierung und Terminologie.

• Prüfen Sie, dass alle Links funktionieren.

• Verwenden Sie gültiges Markdown beziehungsweise MDX.

Als Editor empfehlen wir VS Code.

Vielen Dank für Ihren Beitrag!