Richtlijnen voor het bijdragen

Waarschuwing

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

Er zal altijd vraag zijn naar ontwikkelaars om ons te helpen met het verbeteren van SpongeAPI. Er is niet zoiets als een perfect project en er kan altijd wel wat verbeterd worden. Als je een geïnteresseerde ontwikkelaar bent, twijfel dan geen moment en help ons. Zorg er wel voor dat je onze richtlijnen volgt.

Notitie

Ontwikkelaars die vastberadenheid en consistentie in hun bijdrages aan het project tonen kunnen door de team leiders uitgenodigd worden om toe te treden tot het Sponge team. Er is geen formele aanvraagprocedure. Wij vragen u en niet andersom.

Algemene stappen

  1. Maak uw werkomgeving klaar zoals beschreven is in Voorberedingen voor Ontwikkeling.

  2. Zorg ervoor dat u bekend bent met Git en GitHub. Mocht u uw kennis willen opfrissen dan kan dat hier: Hoe u Git(Hub) moet gebruiken

  3. Kijk voor bestaande problemen in de SpongeAPI, SpongeCommon, SpongeForge, SpongeVanilla, en SpongeDocs opslagplaatsen. Het kan namelijk zijn dat iemand anders al met hetzelfde bezig is. U kunt ook problemen gemarkeerd met “help wanted” bekijken voor problemen waarbij wij uw hulp nodig hebben.

Notitie

Gelieve geen pull request in te dienen voor kleine veranderingen van minder dan 20 regels. In plaats daarvan kunt u beter #sponge joinen op IRC (irc.esper.net) of #spongedev joinen op IRC (irc.esper.net), wij zullen uw wijzigingen dan samenvoegen met enkele andere kleine wijzigingen alvorens een pull request te maken.

  1. Als het probleem een grotere verandering moet ondergaan, wil je misschien het probleem eerst melden voor de benodigde veranderingen, zodat we eerst het probleem kunnen bevestigen en dat we weten dat jij het aan het fixen bent. Je zou ook een WIP (work in progress) pull request moeten maken, met de prefix [WIP] zodat we het alvast kunnen bekijken.

  2. ‘Fork’ het project, kopieer het en maak je veranderingen in een extra branch/zijtak.

  3. Test jouw aanpassingen (let er op dat het correct compileert) en verstuur de wijzigingen naar jouw fork.

  4. Bevestig de pull request met een klein beschrijving met daarin wat je veranderd hebt, en waarom het op die manier zou moeten worden veranderd

  5. Als je extra veranderingen maakt, push de nieuwe commits dan naar jou branch. squash je verandering niet!, dat maakt het heel erg moeilijk voor ons om te zien wat je hebt veranderd in vergelijking met een eerdere versie van je pull request.

  6. Zorg ervoor dat uw PR gerebased is aan de laatste veranderingen van de branch waar u van plan bent mee te mergen. Als u hulp nodig heeft met het rebasen, vraag het ons!

Tip

Als u twijfelt op welke branch u uw werk moet baseren, lees onze Versie-systeem en repository branch layout alvorens uw PR in te dienen.