Mitwirkende würdigen: eine Contributors-Tabelle nach Beitragsart, ohne Rangfolge

Worum es geht

Zwei einander ergänzende Mechanismen. Auf Projektebene die All-Contributors-Spezifikation: ein Contributors-Abschnitt an der prominentesten Stelle der Dokumentation (meist das README, oder eine von dort verlinkte CONTRIBUTORS-Datei, wenn die Liste wächst), formatiert als Tabelle mit Name, einem Link zu mehr Informationen über die jeweilige Person und ihren Beitragskategorien, dargestellt als Text oder Emoji aus einem definierten Schlüssel. Die Spezifikation hält fest, dass die Reihenfolge unerheblich ist, dass Mitwirkende Personen sind, die in irgendeiner Kategorie auf irgendeinem Niveau beitragen, und rät davon ab, eine Person aufgrund des wahrgenommenen Beitragsumfangs von der Liste auszuschliessen. Auf Commit-Ebene der Co-authored-by: Name <email>-Trailer: GitHubs Dokumentation beschreibt, nach einer Leerzeile in der Commit-Meldung eine Trailer-Zeile pro Ko-Autorin hinzuzufügen, mit einer E-Mail-Adresse, die mit dem Konto der Person verknüpft ist, sodass der Commit als deren Beitrag zählt, oder deren No-Reply-Adresse, falls sie diese privat halten möchte.

Warum es wichtig ist

Commit-Logs zeigen nur Code. Triage, Dokumentation, Übersetzungen, Design, das Beantworten von Fragen, Reviews und das Melden von Bugs bleiben dort unsichtbar, und genau das ist die Arbeit, die ein kleines Projekt nutzbar hält. Anerkennung ist eines der wenigen Dinge, die ein Freiwilligenprojekt geben kann, und sie kostet eine Tabellenzeile. Rangfolgen und Zählungen hingegen belohnen Menge statt Nützlichkeit und entmutigen jene, die eine einzige wichtige Sache repariert haben.

So wird es angewendet

• Die Kategorien aus dem Emoji-Schlüssel der Spezifikation übernehmen, oder eine Teilmenge, und in CONTRIBUTING festhalten, dass jede Art zählt.
• Beim ersten Beitrag eine Zeile hinzufügen und nach bevorzugtem Namen und Link fragen; es Personen freistellen, nicht gelistet zu werden.
• Bug- und Sicherheitsmelderinnen im Changelog und im Advisory würdigen, nicht nur in der Tabelle.
• Co-authored-by verwenden, wenn eine Änderung von mehr als einer Person geschrieben wurde, einschliesslich eines Commits, den eine Maintainerin aus dem Entwurf einer anderen Person fertiggestellt hat; eine Person, die reviewt hat, wird im Pull Request gewürdigt, nicht als Autorin.
• Die Tabelle nie nach Menge sortieren und ihr nie Punktzahlen oder Rangabzeichen anhängen.
• Die Tabelle so maschinenlesbar halten, dass ein Bot oder Skript Zeilen hinzufügen kann, damit Anerkennung nicht davon abhängt, dass eine Maintainerin sich erinnert.

Stolpersteine

Eine E-Mail-Adresse auflisten, ohne zu fragen. Nur Personen mit GitHub-Konten hinzufügen und Beiträge vergessen, die per Mail oder Chat eintrafen. Eine Tabelle, die nicht mehr aktualisiert wird, was wie ein Stichtag dafür wirkt, wer zählte.