Specyfikacja
Przykład, w jaki sposób użycie tabeli spec "all-contributors" może rozpoznać wszystkich współtwórców
Obowiązkowe
Projekty Open Source powinny zawierać następujące pola obowiązkowe w kolejności nie stając w sprzeczności ze Specyfikacją All Contributors:
- Sekcja "Contributors" ("Współpracownicy") zawierająca listę wszystkich Współpracowników powinna znajdować się w katalogu
rootlub w innym, wyraźnym miejscu- Naszym celem powinno być wykorzystanie możliwie najbardziej widocznego miejsca w dokumentacji projektu. W wielu przypadkach tym plikiem jest plik
README.md - Consider using a CONTRIBUTORS file in the top level of the repository when the number of project contributors exceeds a level at which it is unfeasible to use the README file to acknowledge contributions. W tym wypadku link prowadzący do
CONTRIBUTORSpowinien znajdować się w nagłówku "Contributors" pliku README
- Naszym celem powinno być wykorzystanie możliwie najbardziej widocznego miejsca w dokumentacji projektu. W wielu przypadkach tym plikiem jest plik
Listapowinna zostać stworzona w formie tabeli i zawierać poniższe informacje o Współpracownikach projektu:- Imię
- URL prowadzący do strony, na której można dowiedzieć się więcej o Współpracowniku. Może zostać on ustalony przez Współpracownika projektu według własnego uznania.
- Oznaczenie kategorii wkładu w formie tekstu lub obrazu ikony przy użyciu zdefiniowanych kategorii wkładu i/lub obrazów emoji (patrz poniżej).
- Link do Kategorii Współtwórców w formacie tekstowym lub obrazka emoji używając określonych Kategorii Współtwórców i/lub obrazka emoji Kategorii Współtwórców.
- Według potrzeby
Lista Współpracownikówmoże zostać podzielona wzdłuż lini (będąc jednocześnie osobną tabelą). - Kolejność autorów nie ma znaczenia w sepcyfikacji. Ustalaj kolejność wg własnego uznania.
- Według potrzeby
- Projekt powinien zdefiniować Współpracowników jako wszystkie osoby, które mają swój udział w projekcie na dowolnym poziomie współpracy oraz niezależnie od Kategorii Współpracy. Niniejsza specyfikacja z definicji uwzględnia każdy wkład. W przypadkach gdzie projekt wykracza poza Kategorie Współtwórców, lub wymaga określonego poziomu wkładu w celu spełnienia kryteriów jako współtwórca, projekt powinien zawierać przejrzystą dokumentację definicji, która zawiera kryteria uczestnika projektu w dokumencie CONTRIBUTING lub podobnym widocznym publicznie dokumencie, który znajduje się na najwyższym poziomie repozytorium. Niniejsza specyfikacja odradza wykluczanie osób z listy współtwórców na podstawie poziomu wniesionego wkładu. Zamiast tego projekt powinien zawierać wskaźniki wkładu, który uwzględnia wszystkich współtwórców projektu na dowolnym poziomie wkładu. Jeśli powyższe wskaźniki zostaną zastosowane, powinny zależeć od danego projektu i nie są obecnie określone.
Wskazówka: Możesz użyć @all-contributors bot 🤖 w celu automatyzacji uwzględniania współtwórców w Twoich projektach open source✨
Opcjonalne
Projekty powinny uwzględniać następujące opcjonalne wskazówki jako część zobowiązania w ramach specyfikacji All Contributors:
- Awatar użytkownika może być dołączony i jest zalecany.
- W celu dostarczenia dodatkowych informacji na temat wkładu (wkładów) w ramach projektu można zamieścić opcjonalny link ze wskaźnika kategorii wkładu (wkładów) zgodnie z poniższą sekcją.