Richtlinien für Beiträge

Warnung

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

Wir brauchen immer Programmierer, die uns helfen die Sponge-API zu verbessern. Da es so etwas wie ein perfektes Ergebnis nicht gibt, wird es immer Dinge geben, die verbessert werden können. Wenn du ein Programmierer bist und interessiert daran bist uns zu helfen, dann zögere nicht. Achte nur darauf, dass du unsere Anleitungen und Regeln befolgst.

Bemerkung

Entwickler, die mit ihren Beitragen zum Projekt Entschlossenheit und Durchhaltevermögen zeigen, könnten von den Teamleitern, nach eigenem Ermessen, eingeladen werden dem Sponge Team beizutreten.

Allgemeine Schritte

  1. Richte deine Arbeitsumgebung gemäß Die Arbeitsumgebung einrichten ein.
  2. Stelle sicher, das du mit Git und GitHub vertraut bist. Falls du eine kleine Auffrischung brauchst, schau dir Wie man Git(Hub)t an.
  3. Sieh nach, ob es Probleme mit der SpongeCommon, SpongeForge, SpongeVanilla, oder den SpongeDocs gibt. Wahrscheinlich arbeitet schon eine andere Person an der selben Sache wie du. Du kannst auch nach Problemen, die mit „help wanted“ markiert wurden, suchen, um uns zu helfen.

Bemerkung

Bitte reiche keine Pull-Requests mit kleinen Änderungen (unter 20 Zeilen) ein. Besuche uns lieber im IRC unter #sponge auf Esper (irc.esper.net) oder #spongedev auf Esper (irc.esper.net).

  1. Wenn dein Problem eine größere Änderung benötigt, willst du vielleicht eine Antwort auf das Problem schreiben ohne das Problem behoben zu haben. So können wir sehen dass du daran arbeitest und unsere Meinung dazu mitteilen. Desweiteren solltest du einen Pull Request mit den Präfix [WIP] (in Arbeit) erstellen. So können wir uns den Code schon mal anschauen, während du diesen noch erweiterst.
  2. Fork das Projekt, klone es und setze deine Änderungen in einem extra Branch um.
  3. Teste deine Änderungen (stelle sicher, dass es sich kompilieren lässt!), commite und pushe die Änderungen zu deinem Fork.
  4. Erstelle deine Pull Requests mit einer kleiner Zusammenfassung, was du geändert hast und warum es so gemacht werden sollte, wie du es gemacht hast.
  5. Wenn du weitere Änderungen machst, pushe die neuen Commits zu deinem Branch. Bitte überschreibe nicht alles, denn das macht es sehr schwer den Überblick über deine Änderungen, im Vergleich zu vorherigen Versionen, zu behalten.
  6. Stelle sicher, dass dein PR auf den letzten Änderungen des Branches basiert, in den er eingepflegt werden soll. Wenn du Hilfe beim Aktualisieren (engl. rebasing) brauchst, frag einfach!

Tipp

Wenn du dir nicht sicher bist, auf welchem Branch dein PR aufbauen soll, schau dir Versionierungssystem und Repository Branch Layout an, bevor du deinen PR einreichst.