Git Workflow pour API et Implémentations

Développer l’API

Le processus de base pour ajouter vos changements est expliqué dans la section Comment utiliser Git(Hub). En plus de cela, nous vous suggérons de créer une nouvelle branche avec un nom évocateur. Avec le nouveau modèle de ramification, vous devrez faire attention à la branche sur laquelle vous basez vos PR et où il devrait être placé par la suite. Vous pouvez en lire plus sur le modèle de ramification et de versioning ici: Organisation des branches du dépôt

De plus, nous devons nous assurer que le module peut être compilé avec gradle compileJava. Ceci lancera une simple compilation des fichiers source. Lorsque le processus a terminé avec succès, vous pouvez présenter vos changements dans le dépôt SpongeAPI.

Développer l’Implémentation

Le processus pour les implémentations est presque le même que pour l’API. Vous ajoutez vos modifications comme décrit dans Comment utiliser Git(Hub). Notez que vous devriez donner un nom évocateur à vos branches. Avec le nouveau modèle de ramification, il faut savoir sur quelle branche vous devez baser votre PR et où elle devrait être fusionnée par la suite. Découvrez le nouveau modèle ramification et de versioning ici: Organisation des branches du dépôt

Lancer gradle compileJava pour vérifier si tout se compile sans erreurs.

Etant donné que vous travaillez sur une implémentation, il y a des chances que votre travail inclut des changements dans l’API. Ce n’est pas grave. Assurez vous seulement que les pointeurs de la version de SpongeAPI correspondent à la version de votre branche avant de commit et de push. Pour faire cela, vous devez ajouter les sous-modules à l’envoie (avec git add SpongeAPI et/ou git add Mixin) avant de commit sur votre dépôt.

Vous devrez ouvrir une requête une fois que vous avez mis votre travaille sur votre fork ou dans le dépôt.