Soumettre une Contribution

Les Bases

Vous aurez d’abord besoin de configurer votre machine pour pouvoir développer pour et avec Sponge:

Quand vous avez terminé et que vous vous sentez prêts pour développer Sponge, décidez sur quoi vous allez travailler.

Rédiger une Contribution

Corriger des Bugs

Expliquez en quelques phrases:

  • quel bug vous avez rencontré, en particulier

    • quel est son comportement

    • comment pensez-vous qu’il doit se comporter

  • ce que vous avez corrigé

  • comment vous l’avez corrigé

Addition Majeure à l’API

Vous avez développé un grand ajout à l’API et vous voulez la proposer. Bien! Les contributions constructives sont celles qui permettent au projet de vivre et de toujours s’améliorer. Ce qui nous amène à une longue et glorieuse rédaction de requête.

Il y a eu quelques uns dans le passé qui vont au-delà des normes, on peut citer:

Bien sûr, ces exemples sont assez extrêmes, mais les contributions qui sont acceptées et qui fournissent un standard de ce qu’il doit être inclus dans une description de requête sont:

Quelques petites choses peuvent être retenues:

  • Les liens vers n’importe quelle requêtes d’implémentation sont placés de manière aérée en haut de la requête, ceci peut être réalisé avec GitHub MarkDown

*SpongeAPI* | [SpongeCommon](html link) | [SpongeDocs](html link)

  • Une description claire de ce que la requête ajoute, ce peut être un bref sommaire comme un brouillon. Le mieux est de faire 4 phrases, mais cela dépend de la fonctionnalité.

  • Des exemples clairs de code pour montrer comment les plugins peuvent utiliser les nouvelles fonctionnalités (et s’il y avait des anciennes fonctionnalités existantes, pourquoi elles ont dû être changées).