Der Git Arbeitsablauf für die API und die Implementierungen

Entwicklung der API

Der grundlegende Prozess, wie man Änderungen vornimmt, ist im Abschnitt Wie man Git(Hub)t erklärt. Zusätzlich empfehlen wir dir, dass du deinem neuen Branch einen aussagekräftigen Namen gibst. Mit dem neuen Branching Aufbau, musst du dir bewusst sein, auf welchem Branch du deinen aufsetzt und in welchen Branch du deine Änderungen einpflegen möchtest. Wenn du mehr über das Branching und Versionierungsschema erfahren möchtest, kannst du das hier nachlesen: Versionierungssystem und Repository Branch Layout

Zusätzlich setzen wir vorraus, dass du sicherstellst, dass das Modul mit gradle compileJava kompiliert. Dieses Skript startet einen einfachen Build (Bau-Prozess) deines Quellcodes. Wenn dies erfolgreich durchläuft, kannst du einen PR (Änderungsvorschlag) im SpongeAPI Repository erstellen.

Entwicklung der Implementierung

Der Prozess für die Implementierungen ist annähernd identisch zu dem der API. Du erstellst deine Änderungen wie in Wie man Git(Hub)t beschrieben ist. Bitte beachte, dass du deinen Branches aussagekräftige Namen gibst. Mit dem neuen Branching Aufbau musst du dir bewusst sein auf welchem Branch du deinen aufbaust und in welchen Branch du deine Änderungen einpflegen möchtest. Wenn du mehr über das Branching und Versionierungsschema erfahren möchtest, kannst du das hier nachlesen: Versionierungssystem und Repository Branch Layout

Führe gradle compileJava aus, um zu überprüfen, dass alles ohne Fehler kompiliert.

Da du an einer Implementierung arbeitest, besteht die Möglichkeit, dass deine Arbeit Änderungen an der API nach sich zieht. Das ist natürlich vollkommen in Ordnung. Achte nur darauf, dass die Verweise für die Versionsnummer der Sponge-API passend zur Versionsnummer deines Entwicklungszweigs sind, bevor du deinen Commit erstellst und hochlädst. Es kann nötig sein Submodules zum Commit hinzuzufügen ( mit``git add SpongeAPI`` und/oder git add Mixin) bevor du deine Arbeit an der Implementierung einreichen kannst.

Du kannst einen Änderungsvorschlag (PR) erstellen, sobald du deinen Commit in deinen Fork oder das Repository hochgeladen hast.