Der Git Arbeitsablauf für die API und die Implementierungen
Entwicklung der API
The basic process of adding your changes is explained in the Wie man Git(Hub)t section. On top of that we suggest that you create your new branch with a meaningful name. With the new branching model, you need to be aware which branch you need to base your PRs on and where it should get merged afterwards. Read about the new branching and versioning model here: Repository-Branch-Layout
Additionally, we require that you ensure the module will compile with gradle compileJava
.
This will run a simple build of the source files. When finished successfully, you can PR your changes to SpongeAPI
repo.
Entwicklung der Implementierung
The process for the implementations is almost the same as for the API. You add your changes as described in Wie man Git(Hub)t. Note that you should give your branches a meaningful name. With the new branching model, you need to be aware which branch you need to base your PRs on and where it should get merged afterwards. Read about the new branching and versioning model here: 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 SpongeAPI 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.