Spezifikation
Ein Beispiel, wie die Liste aller Mitwirkenden dazu genutzt werden kann die Beiträge der jeweiligen Personen anzuerkennen.
Erforderlich
Open source projects should include the following mandatory items to support the All Contributors specification:
- 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 vielen Fällen ist dies die README Datei des Projekts
- 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
- 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).
- Ein Link zur Beitragskategorie im Text- oder emoji-Format mit den definierten Beitragskategorien und/oder Beitragskategorien emoji.
- The list of contributors can be spread across multiple lines (each technically being its table) as needed.
- Die Reihenfolge der Mitwirkenden ist für die Spezifikation unerheblich Sortiere sie wie es Dir beliebt.
- 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 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. 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: Du kannst den @all-contributors Bot 🤖 verwenden, um die Anerkennung von Beitragenden zu deinem Open-Source-Projekt zu automatisieren. ✨
Optional
Projekte sollten diese optionalen Punkte beim Einsatz der All Contributors Spezifikation in Betracht ziehen:
- Der Avatar des Benutzers soll angezeigt werden. Dies wird empfohlen.
- 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.