Skip to main content
Zasób Humalike dla FiveM przyjmuje pull requesty od społeczności. Mile widziane są ukierunkowane poprawki błędów, testy, usprawnienia wydajności, ogólne integracje i korekty dokumentacji.

​
Najpierw omów funkcje

Porozmawiaj z nami na Discordzie, zanim zaimplementujesz zmianę, która:
  • dodaje funkcję lub opcję konfiguracji;
  • zmienia zachowanie NPC, głosu, świata lub integracji;
  • dodaje lub zmienia możliwość dostawcy;
  • zmienia komunikację między zasobem FiveM a Humalike;
  • zmienia publiczny eksport, zdarzenie, convar, polecenie lub kontrakt danych;
  • dodaje zależność lub zmienia pakowanie wydania.
Daje to opiekunom i współtwórcom szansę uzgodnienia publicznego kontraktu, zanim rozpocznie się istotna praca implementacyjna. Drobne poprawki, testy i korekty dokumentacji mogą trafić bezpośrednio do pull requesta.

​
Zachowuj publiczne kontrakty

Nie zmieniaj samodzielnie kontraktu komunikacji między zasobem a Humalike, przebiegu uwierzytelniania lub licencjonowania, obsługi poświadczeń runtime, adresów usług ani ładunków protokołu. Te zmiany wymagają wcześniejszej zgody opiekunów i skoordynowanego wydania. Traktuj wersjonowane API dostawców, publiczne eksporty, zdarzenia, convary i polecenia jako kontrakty zgodności. Zmiany addytywne nadal wymagają omówienia. Zmiany łamiące zgodność wymagają jawnego planu migracji. Utrzymuj rdzeń zasobu samodzielnym i neutralnym wobec frameworków. Specyficzne dla klienta prace, zasady ekonomii, uprawnienia, prywatne zdarzenia i hooki UI należą do osobnego mostu. Ogólna integracja z frameworkiem musi używać publicznych API, pozostawać opcjonalna i zachowywać działanie samodzielne. Nigdy nie commituj poświadczeń, kluczy licencyjnych, prywatnych endpointów, danych klientów, informacji o wdrożeniach ani wygenerowanych danych runtime.

​
Prześlij pull request

  1. Utwórz gałąź z aktualnej gałęzi main.
  2. Ogranicz pull request do jednego zachowania lub kontraktu.
  3. Dodaj ukierunkowane testy dla zmian zachowania.
  4. Zaktualizuj dokumentację, gdy zmienia się wspierana publiczna powierzchnia.
  5. Wyjaśnij motywację, wpływ na zgodność i sposób walidacji w opisie pull requesta.
Przed przesłaniem pull requesta uruchom sprawdzenia udokumentowane w przewodniku współtworzenia w repozytorium. Opiekunowie mogą poprosić o podzielenie szerokiej zmiany lub dostosowanie jej projektu w celu ochrony zgodności.

​
Zgłaszaj problemy bezpieczeństwa prywatnie

Nie publikuj podatności w zgłoszeniu ani wiadomości na Discordzie. Użyj prywatnego zgłaszania podatności GitHub.