Pull Requests (PRs)
Um eine saubere und stabile Codebasis zu gewährleisten, müssen alle Beiträge den NDM-Richtlinien für Pull Requests entsprechen.
Schritte
-
Einen Fork erstellen Alle Änderungen müssen in deinen Fork gepusht werden, niemals direkt in das Haupt-Repository.
-
Änderungen klein halten Umfangreiche PRs sind schwer zu überprüfen und führen oft zu versteckten Problemen. Bevorzuge mehrere kleine PRs gegenüber einem großen.
-
Das PR-Formular vollständig ausfüllen Die PR-Vorlage soll den Reviewern helfen, deine Änderungen zu verstehen. Unvollständige PRs werden nicht überprüft.
Wichtig
- Sicherstellen, dass die CI erfolgreich durchläuft
Dein PR muss folgende Prüfungen bestehen:
- Build-Checks
- Sicherheitsüberprüfung (Security Audit)
- Alle Tests
- Linter
- Formatter
- Aussagekräftige Commit-Nachrichten schreiben Vermeide Nachrichten wie „fix stuff“ oder „update code“. Verwende klare, beschreibende Nachrichten.