Code-Beiträge
In diesem Leitfaden erhältst du einen Überblick über den Beitrags-Workflow vom Eröffnen eines Problems über das Erstellen eines PRs bis hin zum Überprüfen und Zusammenführen des PRs.
Wenn du Code zu diesem Projekt beitragen möchtest, befolge bitte die folgenden Schritte:
Löse ein Problem
'Read the “', Löse ein Problem, '” section'Durchsuche unsere bestehenden Issues^, um eine zu finden, die dich interessiert. Du kannst die Suche eingrenzen, indem du labels
als Filter verwendest. Wenn du ein Problem findest, an dem du arbeiten möchtest, kannst du gerne einen PR mit einer Lösung eröffnen.
Änderungen vornehmen
'Read the “', Änderungen vornehmen, '” section'-
Forke das Repository.
-
GitHub Desktop verwenden:
- Erste Schritte mit GitHub Desktop^ führt dich durch die Einrichtung von Desktop.
- Sobald der Desktop eingerichtet ist, kannst du ihn benutzen, um das Repo zu forken^!
-
Benutze die Kommandozeile:
- Forke das Repo^, damit du deine Änderungen vornehmen kannst, ohne das ursprüngliche Projekt zu beeinflussen, bis du sie zusammenführen kannst.
-
-
Installiere oder aktualisiere Node.js und pnpm, auf die Versionen, die in
.prototools
^ definiert sind. -
Erstelle einen Branch und beginne mit deinen Änderungen!
-
Schreibe Tests für deine Änderungen, falls zutreffend.
-
Aktualisiere die Dokumentation, falls nötig.
Commite deine Änderungen
'Read the “', Commite deine Änderungen, '” section'Commite die Änderungen, wenn du mit ihnen zufrieden bist.
Pull Request
'Read the “', Pull Request, '” section'Wenn du mit den Änderungen fertig bist, erstelle einen Pull Request, auch PR genannt.
- FFülle die Vorlage „Bereit zur Überprüfung“ aus, damit wir deinen PR überprüfen können. Diese Vorlage hilft den Prüfern, deine Änderungen und den Zweck deines Pull Requests zu verstehen.
- Vergiss nicht, PR zum Issue^ zu verknüpfen, wenn du eine Aufgabe löst.
- Aktiviere das Kontrollkästchen Erlaube Bearbeitungen der Maintainer^, damit der Branch für eine Zusammenführung aktualisiert werden kann. Sobald du deinen PR eingereicht hast, wird ein Mitglied des Docs-Teams deinen Vorschlag prüfen. Wir können Fragen stellen oder zusätzliche Informationen anfordern.
- Wir können um Änderungen bitten, bevor ein PR zusammengeführt werden kann, entweder mit Änderungsvorschlägen^ oder mit Pull Request-Kommentaren. Du kannst die vorgeschlagenen Änderungen direkt über die Benutzeroberfläche übernehmen. Du kannst alle anderen Änderungen in deinem Fork vornehmen und sie dann in deinen Branch übertragen.
- Wenn du deinen PR aktualisierst und Änderungen vornimmst, markiere jede Unterhaltung als gelöst^.
- Wenn du auf Probleme beim Zusammenführen stößt, schau dir diese Git-Anleitung^ an, welche dir hilft, Konflikte beim Zusammenführen und andere Probleme zu lösen.
Dein PR wird zusammengeführt!
'Read the “', Dein PR wird zusammengeführt!, '” section'Herzlichen Glückwunsch! Das StudioCMS-Team dankt dir. Dein Beitrag wird Teil der nächsten Version sein.
Jetzt, wo du Teil der StudioCMS-Community bist, kannst du uns helfen, andere PRs zu überprüfen, Fragen zu beantworten und anderen Autoren zu helfen. Wenn du es noch nicht getan hast, melde dich in unserem Discord^ an, um dich mit anderen Autoren und dem StudioCMS-Team auszutauschen.
Oh, und du wirst dein Gesicht in der Liste der Mitwirkenden sehen! 🎉