Edit

Korzystanie z CLI

Poniższa dokumentacja zakłada, że wykonane zostały już kroki związane z instalacją CLI.

Wtrącenie: Poniższy kod all-contributors został przez nas załączony w celu uproszczenia, jeśli jednak posiadasz jakiekolwiek wątpliwości, przekaż to zadanie Yarnowi yarn all-contributors 😺

Komendy

all-contributors init

Użyj jej w momencie gdy zaczynasz korzystać z all-contributors-cli po raz pierwszy. Zostanie zadanych Ci kilka pytań, a następnie utworzony projekt dla all-contributors. Ustawienia zawierają utworzenie pliku konfiguracyjnego .all-contributorsrc oraz stworzenie tabeli kkontrybutorów w pliku, który określiłeś (zazwyczaj w README.md).

all-contributors add

Użyj add, aby dodać nowych kontrybutorów do swojego projektu lub aby dodać inne możliwości kontrybucji. Zostaną oni dodani do pliku konfiguracyjnego, a lista kontrybutorów zostanie zaktualizowana kiedy użyjesz komendy generate.

# Dodaj <nazwę użytkownika> nowego kontrybutora, który ma swój wkład w projekt poprzez <kontrybucję>
all-contributors add <nazwa użytkownika> <kontrybucja>
# Przykład:
all-contributors add robertgrzonka code, doc

Gdzie nazwa użytkownika to nazwa użytkownika na GitHubie lub GitLabie oraz kontrybucja to ,-oddzielone przecinkiem typy kontrybucji do projektu. Zobacz Klucz Emoji (Typy Kontrybucji), aby sprawdzić wszystkie dozwolone typy kontrybucji.

Użytkownicy GitLab: Sprawdź dodatkowe wymagania dla użytkowników GitLaba

all-contributors check

Użyj check, aby porównać kontrybutorów GitHuba z tymi, którzy zawarci są już w pliku .all-contributorsrc aby upewnić się, że uznanie trafia tam gdzie powinno.

Zważając na restrykcje związane z API GitHuba, komenda ta działa tylko w projektach z ilością poniżej 500 kontrybutorów (chyba, że ustawiony jest PRIVATE_TOKEN jak wspomniano poniżej w Użytkownicy GitHuba).

all-contributors generate

Użyj generate, aby wczytać listę kontrybutorów z pliku .all-contributorsrc oraz aby zaktualizować tabelę według podanych kluczy.

Zwróć uwagę, że musi mieć możliwość znalezienia tagów w odpowiedniej kolejności, aby zaktualizować tabelę:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Also note that it needs to find the following tags in order to update the badge:

<!-- ALL-CONTRIBUTORS-BADGE:START - Nie usuwaj ani nie modyfikuj tej sekcji -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Użytkownicy GitHuba

W niektórych wypadkach może pojawić się wiadomość z błędem GitHub API rate limit exceeded for xxx. Pomóc tutaj może ustawienie zmiennej środowiskowej PRIVATE_TOKEN, aby ominąć ograniczenia GitHuba.

Prywatny token to Twój osobisty token służący do autentyfikacji z API GitHuba.

Użytkownicy GitLaba

Zwróć uwagę, że jeśli używasz instancji GitLaba hostowanej przez siebie, niektóre komendy mogą wymagać ustawienia najpierw zmiennej środowiskowej PRIVATE_TOKEN.

Prywatny token to Twój osobisty token służący do autentyfikacji z API GitLaba.

# ustaw prywatny token na Linux
export PRIVATE_TOKEN=your_private_token
# ustaw prywatny token na Windows
set PRIVATE_TOKEN=your_private_token

Co dalej

← InstalacjaKonfiguracja →