Spezifikation

Ein Beispiel, wie die Liste aller Mitwirkenden dazu genutzt werden kann die Beiträge der jeweiligen Personen anzuerkennen.

Erforderlich

Open-Source-Projekte sollten die folgenden notwendigen Elemente enthalten, um der „All Contributors“-Spezifikation zu entsprechen:

1. Ein Abschnitt “Mitwirkende” in einer prominenten Seite der Projektdokumentation, der eine Liste aller Mitwirkenden enthält
   • Ziel sollte es sein, wenn möglich, die prominenteste Seite der Projektdokumentation zu nutzen. 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. In diesem Fall sollte ein prominenter Link zur CONTRIBUTORS Datei auf der README Seite unter der Rubrik “Mitwirkende” enthalten sein
2. Die Liste sollte als Tabelle mit folgenden Informationen über die Mitwirkenden im Projekt formatiert werden:
   • Name
   • Link zu einer Seite, auf der man mehr Informationen über die Mitwirkenden erfahren kann. Diese URL kann vom Mitwirkenden nach Ermessen des Projekts bestimmt werden.
   • Ein Hinweis auf die Beitragskategorie im Text- oder Icon-Bildformat mit den definierten Beitragskategorien und/oder Beitragskategorien Emoji-Bildern (siehe unten).
   • A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or Contribution Categories emoji.
     • Die Liste der Mitwirkenden kann nach Bedarf über mehrere Zeilen verteilt werden (jede ist dann technisch gesehen eine eigene Tabelle).
     • Die Reihenfolge der Mitwirkenden ist für die Spezifikation unerheblich Sortiere sie wie es Dir beliebt.
3. Projekte sollten Mitwirkende als diejenigen definieren, die an einem Projekt in einer der Beitragskategorien mitwirken. Diese Spezifikation schliesst per Definition alle Mitwirkenden mit ein. In Fällen, in denen Projekte andere Beitragskategorien verwenden oder ein gewisses Beitragsniveau fordern, um als Mitarbeit zu zählen, sollte das Projekt eine genaue Dokumentation dieser Kriterien bereitstellen. Die Bedingungen, die Mitarbeit definieren, sollten in der CONTRIBUTING Datei oder an ähnlich sichtbarer Stelle auf der obersten Ebene des Projekts benannt werden. Diese Spezifikation empfiehlt nicht Mitwirkenden, aufgrund eines als möglicherweise gering wahrgenommenen Beitrags, von der Liste aller Mitwirkenden auszuschliessen. Stattdessen sollten Projekte Kriterien für das Mitwirken auflisten, die alle Mitwirkenden an dem Projekt auf jedem Niveau mit einbeziehen. Bei Verwendung sind diese Kriterien für das Mitwirken im alleinigen Ermessen des jeweiligen Projekts und werden derzeit nicht spezifiziert.

Tipp

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

Optional

Projekte sollten diese optionalen Punkte beim Einsatz der All Contributors Spezifikation in Betracht ziehen:

1. Der Avatar des Benutzers soll angezeigt werden. Dies wird empfohlen.
2. Ein optionaler Link auf dem Icon der Beitragskategorien zu den einzelnen Beiträgen kann enthalten sein, um zusätzliche Informationen über den Mitwirkenden zu geben, wie in folgendem Abschnitt beschrieben.