Rozpoczęcie pracy z Pull-Request

Ostrzeżenie

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.

Podstawy pracy

Najpierw musisz skonfigurować swój komputer, aby móc rozwijać się dla oraz z Sponge:

Gdy już skończysz i będziesz czuł, że jesteś gotowy do rozwoju Sponge, to musisz zdecydować nad którymi elementami chcesz pracować.

Pisanie PR

Poprawa błędów

Wyjaśnienie w kilku zdaniach:

  • błędów napotkanych przez Ciebie, zwłaszcza

    • jak się zachowywał

    • jak uważasz, że powinien zachowywać się

  • co takiego naprawiłeś

  • jak naprawiłeś to

Główny dodatek interfejsu API

Więc, rozwinąłeś ogromny dodatek intefejsu API który chcesz zatwierdzić jako PR. Dobrze! Konstruktywne PR jest tym co sprawia, że ten projekt ciągle staje się lepszy. To nas doprowadza do napisania chwalebnego opisu PR.

W przeszłości wystąpiło kilka, które poszły w górę ponad standardy, na przykład:

Oczywiście, te przykłady są ekstremalne, ale PRy które są akceptowane i zapewniają dobre standardy tego co powinny zawierać w opisie to:

Kilka rzeczy może zostać z tego wyciągnięta:

  • Linki do każdej realizacji PRs w Wyczyść widok w górnej części PR, można to osiągnąć z GitHub Markdown

*SpongeAPI*|[SpongeCommon](html link)|[SpongeForge](html link)|[SpongeVanilla](html link)

  • Clear description of what the API PR is aiming to do, this can be a brief summary as if writing an essay, at most 4 sentences long, depending on what the functionality is.

  • Wyczyść przykłady kodu, w jaki sposób wtyczki mogą wykorzystywać nowe funkcje (i czy istnieją stare funkcje, dlaczego muszą zostać zmienione).