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 obowiązkowe elementy, aby wspierać specyfikację All Contributors:

1. Sekcja “Contributors” (“Współpracownicy”) zawierająca listę wszystkich Współpracowników powinna znajdować się w katalogu root lub w innym, wyraźnym miejscu
   • Naszym celem powinno być wykorzystanie możliwie najbardziej widocznego miejsca w dokumentacji projektu. In many cases, this is the project README.md file
   • 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 CONTRIBUTORS powinien znajdować się w nagłówku “Contributors” pliku README
2. Lista powinna 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).
   • A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or Contribution Categories emoji.
     • Lista współtwórców może być rozłożona na wiele wierszy (każdy technicznie jest osobną tabelą), w zależności od potrzeb.
     • Kolejność autorów nie ma znaczenia w sepcyfikacji. Ustalaj kolejność wg własnego uznania.
3. 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, gdy projekty odbiegają od Kategorii Wkładów lub wymagają określonego poziomu wkładu, aby spełnić kryteria jako współtwórca projektu, projekt powinien udostępnić jasną dokumentację definicji, które spełniają kryteria współtwórcy projektu w dokumencie CONTRIBUTING lub podobnym ważnym publicznym dokumencie na najwyższym poziomie repozytorium projektu. 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

You can use the @all-contributors bot 🤖 to automate acknowledging contributors to your open source projects ✨

Opcjonalne

Projekty powinny uwzględniać następujące opcjonalne wskazówki jako część zobowiązania w ramach specyfikacji All Contributors:

1. Awatar użytkownika może być dołączony i jest zalecany.
2. 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ą.