Zasady współpracy

Zawsze będziemy potrzebować Deweloperów przy ulepszaniu SpongeAPI. Nie ma takiej rzeczy jak perfekcyjny projekt i każda funkcja może być zawsze ulepszana. Jeśli jesteś Deweloperem i jesteś chętny do pomocy to nie wahaj się. Po prostu upewnij się, że postępujesz z naszymi wytycznymi.

Informacja

Programiści Rozwojowi, którzy zademonstrują swoją determinację i stałą chęć współtworzenia projektu, mogą zostać zaproszeni przez Liderów Zespołu do przyłączenia się według uznania kierowników. Nie mamy jeszcze żadnej formalnej procedury. Prosimy o nie dopytywanie się, gdyż w odpowiednim czasie zapytamy Cię to.

Ogólne kroki

  1. Skonfiguruj swój obszar roboczy, jak opisano w Przegotowanie do tworzenia.

  2. Upewnij się, że jesteś zaznajomiony z Git i GitHub. Jeśli twoja wiedza wymaga odświeżenia to zerknij tutaj: Praca z Git(Hub)

  3. Sprawdź, jakie istnieją problemy w repozytoriach SpongeAPI, SpongeCommon, SpongeForge, SpongeVanilla i SpongeDocs. To prawdopodobnie ktoś już pracuje nad tym samym. Możesz również sprawdzić oznaczone zagadnienia jako „chciał pomóc” w celu oznajmienia się z problemami w których może potrzebujemy twojej pomocy.

Informacja

Proszę nie wysyłać pull requestów dla małych, niefunkcjonalnych zmian, takich jak naprawianie błędów ortograficznych lub zmiana nazwy zmiennych. Zamiast tego możesz:

  1. Jeśli problem wymaga większej zmiany, możesz najpierw zgłosić problemy bez niezbędnych zmian, abyśmy mogli potwierdzić ten problem i wiedzieć, że pracujesz nad jego rozwiązaniem. Powinieneś również utworzyć pull request lub komentarz z ~wip, abyśmy mogli zacząć je przeglądać.

  2. Zforkuj projekt, sklonuj go i wprowadź zmiany w dodatkowej gałęzi.

  3. Sprawdź swoje zmiany (upewnij się, że się kompilują!), zcommituj i wstaw je do swojego forka.

  4. Wykonaj swoje żądanie Pull-Request wraz z krótkim podsumowaniem wprowadzonych przez Ciebie zmian oraz uzasadnieniem, dlaczego powinno być to zrobione w taki, a nie inny sposób.

  5. Jeżeli stworzysz dodatkowe zmiany, stwórz nowy commits do twojej gałęzi. Nie ukrywaj swoich zmian, gdyż sprawia to, że bardzo trudno zobaczyć, co zmieniono w porównaniu do poprzedniej wersji Pull Request.

  6. Upewnij się, że PR jest ponownie wyznaczone na najnowsze zmiany jeśli masz zamiar połączyć go do nowej gałęzi. Jeśli potrzebujesz pomocy do ponownego wyznaczenia to po prostu zapytaj!

Wskazówka

Jeśli nie masz pewności jaką gałąź (branch) należy oprzeć swoją pracę to przeczytaj o naszych Repository Branch Layout przed przesłaniem swojego PR.