Änderungen einreichen
Dieser Leitfaden behandelt den Prozess für das Einreichen von Code-Verbesserungen zu Rayforge.
Einen Feature-Branch erstellen
Erstelle einen beschreibenden Branch für deine Änderungen:
git checkout -b feature/ihr-feature-name
# oder
git checkout -b fix/issue-nummer-beschreibung
Änderungen vornehmen
- Folge dem bestehenden Code-Stil und Konventionen
- Schreibe saubere, fokussierte Commits mit klaren Nachrichten
- Füge Tests für neue Funktionalität hinzu
- Aktualisiere Dokumentation nach Bedarf
Änderungen testen
Führe die vollständige Test-Suite aus, um sicherzustellen, dass nichts kaputt ist:
# Alle Tests und Linting ausführen
pixi run test
pixi run lint
Mit Upstream synchronisieren
Bevor du einen Pull-Request erstellst, synchronisiere mit dem Upstream-Repository:
# Die neuesten Änderungen abrufen
git fetch upstream
# Deinen Branch auf dem neuesten Main rebasen
git rebase upstream/main
Einen Pull-Request einreichen
-
Pushe deinen Branch zu deinem Fork:
git push origin feature/ihr-feature-name -
Erstelle einen Pull-Request auf GitHub und fülle die Pull-Request-Vorlage aus:
- Eine klare Überschrift und eine Beschreibung der Änderung und des Problems, das sie löst
- Warum du deinen konkreten Architektur-Ansatz gewählt hast und welche Alternativen du verworfen hast
- Die genauen Schritte, mit denen du die Änderung lokal getestet hast
- Referenz auf verwandte Issues
- Screenshots, wenn die Änderung die UI betrifft
- Jede Checkbox der Checkliste in der Vorlage angekreuzt
Pull-Requests, die die Vorlage nicht ausfüllen, werden automatisch von einem Bot geschlossen. Bearbeite die Beschreibung des Pull-Requests, sodass jeder Abschnitt beantwortet und jede Checkbox angekreuzt ist — der Pull-Request wird danach automatisch wieder geöffnet.
Code-Review-Prozess
- Alle Pull-Requests erfordern Review vor dem Mergen
- Gehe zeitnah auf Feedback ein und mache angeforderte Änderungen
- Halte die Diskussion fokussiert und konstruktiv
Merge-Anforderungen
Pull-Requests werden gemergt, wenn sie:
- Alle automatisierten Tests bestehen
- Dem Code-Stil des Projekts folgen
- Appropriate Tests für neue Funktionalität enthalten
- Dokumentations-Updates haben, falls erforderlich
- Von mindestens einem Maintainer genehmigt sind
KI-unterstützter Code
Wir begrüßen die Nutzung von KI-Werkzeugen beim Schreiben von Code. Trotzdem bist du streng für den von dir eingereichten Code verantwortlich. Du MUSST ihn vollständig verstehen und musst in der Lage sein, die Architekturentscheidungen zu erklären.
KI-generierter Code führt oft subtile Bugs, architektonische Diskrepanzen und Sicherheitslücken ein. Pull-Requests, die wie rohe, unüberprüfte KI-Ausgaben wirken, werden geschlossen, um die Zeit der Maintainer zu respektieren.
Zusätzliche Richtlinien
Commit-Nachrichten
Verwende klare, beschreibende Commit-Nachrichten:
- Beginne mit einem Großbuchstaben
- Halte die erste Zeile unter 50 Zeichen
- Verwende den Imperativ ("Feature hinzufügen" nicht "Feature hinzugefügt")
- Füge bei Bedarf mehr Details im Body hinzu
Kleine, fokussierte Änderungen
Halte Pull-Requests auf ein einzelnes Feature oder einen Fix fokussiert. Große Änderungen sollten in kleinere, logische Teile zerlegt werden.
Für größere Änderungen öffne zuerst ein Issue, um deinen Ansatz zu besprechen, bevor du erhebliche Zeit investierst.
Wenn du unsicher über einen Teil des Beitragsprozesses bist, zögere nicht, in einem Issue oder einer Diskussion um Hilfe zu fragen.