Entwicklungsrichtlinien

Unser Ziel

Wir wollen zusammen an Projekten arbeiten, die für alle nachvollziehbar sind. Deshalb ist es wichtig, dass wir gut dokumentieren, sauber programmieren und offen kommunizieren.

Grundregeln

• Arbeite in kleinen, klaren Schritten.
• Schreibe klare Commit-Nachrichten.
• Vermeide zu große Änderungen auf einmal.
• Nutze Branches für neue Funktionen oder Fehlerbehebungen.
• Kläre offene Fragen im Team, bevor du weitermachst.

Branching und Versionskontrolle

Unsere Entwicklungsarbeit erfolgt in Git-Branches:

• main bleibt stabil und enthält die veröffentlichten Inhalte.
• feature/... wird für neue Funktionen genutzt.
• fix/... dient für Fehlerkorrekturen.
• docs/... ist für Dokumentationsänderungen.

Fasse einen klaren Arbeitsbereich pro Branch zusammen und mache regelmäßige Pull Requests, sobald ein Thema fertig ist.

Code-Qualität und Style

Unser Code soll leicht lesbar und verständlich sein:

• Nutze sprechende Namen für Variablen, Funktionen und Dateien.
• Schreibe kurze Funktionen mit einer klaren Aufgabe.
• Kommentiere nur dort, wo der Zweck nicht unmittelbar klar ist.
• Halte dich an bestehende Projektkonventionen und den aktuellen Stil.

Review und Zusammenarbeit

Bevor Änderungen in den Hauptbranch gemerged werden, sollten sie von mindestens einer anderen Person geprüft werden:

• Erkläre in deinem Pull Request, was sich ändert und warum.
• Schreibe, welche Bereiche getestet wurden.
• Bitte um Feedback, wenn du unsicher bist.
• Setze Änderungen nach dem Review zeitnah um.

Dokumentation

Jede technische Änderung sollte dokumentiert werden, wenn sie den Ablauf, die Installation oder die Nutzung beeinflusst.

• Ergänze Anleitungen oder Wiki-Einträge bei neuen Funktionen.
• Aktualisiere vorhandene Dokumentation bei Änderungen.
• Beschreibe die Konfiguration und die notwendigen Schritte für die Nutzung.

Tests und Qualitätskontrolle

Teste Änderungen vor dem Merge so gut wie möglich:

• Prüfe neue Funktionen in einer Testumgebung.
• Führe gegebenenfalls automatische Prüfungen aus.
• Beobachte nach dem Merge kurz, ob alles erwartungsgemäß läuft.

Kommunikation

Gute Abstimmung ist entscheidend:

• Nutze Discord oder andere Teamkanäle für Fragen und Absprachen.
• Informiere andere, wenn du größere Änderungen planst.
• Halte die Teammitglieder über Fortschritte und Probleme auf dem Laufenden.

Verantwortung und Pflege

Entwicklungsarbeit hört nicht mit dem Merge auf. Wir übernehmen Verantwortung für die Pflege der Lösungen:

• Behebe auftretende Fehler zeitnah.
• Verbessere Dokumentation bei Bedarf.
• Überprüfe regelmäßig, ob alte Lösungen noch passen.