Richtlinien für Beiträge

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äß Vorbereitung für die Entwicklung 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. Check for existing issues in the SpongeAPI, SpongeCommon and SpongeDocs repositories. There is possibly someone else already working on the same thing. You can also check issues marked with „help wanted“ for existing issues we need your help with.

Bemerkung

Please don’t submit pull requests for small, non-functional changes such as fixing typos or renaming variable names. Instead, you can:

• join #spongedev on IRC (irc.esper.net) and we’ll change it together with the other smaller changes.

• Join our Discord Server and post on the #dev channel. Discord and IRC are linked, so don’t worry. We won’t miss your message!

• You can also add it to our list of Minor Issues on GitHub.

4. If the issue requires a bigger change you may want to submit the issues without the necessary changes first, so we can confirm the issue and know that you’re working on fixing it. You should also create a draft pull request or comment with ~wip so we can already start reviewing them.

5. Fork das Projekt, klone es und setze deine Änderungen in einem extra Branch um.

6. Teste deine Änderungen (stelle sicher, dass es sich kompilieren lässt!), commite und pushe die Änderungen zu deinem Fork.

7. 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.

8. 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.

9. 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 Repository-Branch-Layout an, bevor du deinen PR einreichst.