Lignes directrices des contributions

Il n’y aura jamais trop de développeurs pour nous aider à améliorer SpongeAPI. Il n’existe pas de projet parfait et les choses peuvent toujours être améliorées. Si vous êtes un développeur intéressé par Sponge, n’hésitez pas, il n’y a qu’à suivre nos lignes directrices.

Note

Les développeurs qui montrent de la détermination et de la cohérence dans leurs contributions au projet peuvent être invités à rejoindre l’équipe de Sponge par les Chefs d’Équipe, à leur discrétion. Il n’y a aucun processus de demande formelle. Merci de ne pas demander à l’équipe, nous vous demanderons.

Étapes générales

1. Configurez votre espace de travail comme indiqué dans Préparation pour le développement.

2. Assurez-vous de savoir utiliser Git et GitHub. Si vos connaissances ont besoin d’un petit rafraîchissement, jetez un œil ici: Comment utiliser Git(Hub)

3. Vérifier les problèmes existants dans les dépôts SpongeAPI et Sponge . Il y a peut-être quelqu’un d’autre qui travaille déjà sur la même chose. Vous pouvez également vérifier les problèmes signalés avez « help wanted « <https://github.com/SpongePowered/SpongeAPI/labels/help%20wanted> _ pour les problèmes existants où nous avons besoin de votre aide.

Note

Merci de ne pas soumettre de pull request pour des petites modifications non fonctionnelles telles que la correction de fautes ou le renommage de variables. À la place, vous pouvez :

• rejoignez #spongedev sur IRC (irc.esper.net) et nous le changerons en même temps que d’autres petits changements.

• Rejoignez notre serveur Discord et postez sur le salon #dev. Discord et IRC sont liés, donc ne vous inquiétez pas. Nous ne raterons pas votre message !

• Vous pouvez également l’ajouter à notre liste de Problèmes Mineurs sur GitHub.

4. Si le problème nécessite un plus grand changement, vous voudrez probablement soumettre les problèmes sans faire les changements nécessaires d’abord, pour que nous puissions confirmer le problème et savoir que vous travaillez sur sa correction. Vous devrez aussi créer une draft pull request ou commenter avec ~wip pour que nous puissions commencer à l’examiner.

5. Modifiez le projet, clonez-le et apportez vos modifications dans une nouvelle branche.

6. Testez vos modifications (assurez-vous que le tout compile !), faites un commit et envoyez-le dans votre fork.

7. Soumettez la demande avec un bref résumé de ce que vous avez changé et pourquoi l’avoir fait de cette manière.

8. Si vous apportez des modifications supplémentaires, faites de nouveaux commits sur votre branche. N’écrasez pas vos modifications, si vous le faites il devient très difficile de voir ce que vous avez changé par rapport à la version précédente.

9. Assurez-vous que votre contribution est basée sur les tous derniers changements de la branche ciblée. Si vous avez besoin d’aide pour la rebaser, vous pouvez demander!

Astuce

Si vous ne savez pas sur quelle branche vous baser, consultez Organisation des branches du dépôt avant de soumettre votre contribution.