Edit

Specyfikacja

Przykład, w jaki sposób użycie tabeli spec "all-contributors" może rozpoznać wszystkich współtwórców

Tabela Współpracowników

Obowiązkowe

Open source projects should include the following mandatory items to support the All Contributors specification:

  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. 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 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).
    • 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.
      • The list of contributors can be spread across multiple lines (each technically being its table) as needed.
      • 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. In cases where projects deviate from the Contribution Categories or require a specific contribution level to meet criteria as a project contributor, the project should provide explicit documentation of the definitions that satisfy the project contributor criteria in the CONTRIBUTING document or a similar prominent public document at the top level of the project repository. 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:

  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ą.

Co dalej

← PrzeglądZnacznik Emoji ✨ →