Lignes directrices des contributions

Avertissement

Cette documentation est faire pour une ancienne version de SpongeAPI et n’est plus maintenue. Même si les examples de code fonctionnent toujours pour cette version de l’API, les politiques, lignes de conduite, et quelques liens peuvent avoir changé. Veuillez vous rendre sur la dernière version de la documentation pour ces derniers.

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 la page 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. Recherchez les problèmes existants dans les dépôts de SpongeAPI, SpongeCommon, SpongeForge, SpongeVanilla, et SpongeDocs. Il y a peut être quelqu’un qui travaille sur la même chose que vous. Regardez également les problèmes marqués d’un tag « help wanted » pour les problèmes existants qui ont besoin de votre aide.

Note

Veuillez ne pas soumettre de contribution pour des changements de moins de 20 lignes. À la place, rejoignez #sponge sur IRC (irc.esper.net) ou #spongedev sur IRC (irc.esper.net) et nous effectuerons les changements avec d’autres.

  1. Si le problème nécessite des changements plus important, vous pouvez commencer par soumettre un rapport de bug sans correctifs, afin que nous puissions confirmer le bug et savoir que vous travaillez sur un correctif. Vous devriez également créer une pull request préfixée par [WIP] afin que nous puissions déjà vérifier vos changements.

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

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

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

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

  6. 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 Système de Gestion de Versions et Disposition de Branches du Dépôt avant de soumettre votre contribution.