Reconnaître les contributeurs : un tableau de contributeurs par type de contribution, sans classement

Ce que c'est

Deux mécanismes complémentaires. Au niveau du projet, la spécification All Contributors : une section Contributeurs dans la documentation la plus visible (généralement le README, ou un fichier CONTRIBUTORS lié depuis celui-ci lorsque la liste s'allonge), mise en forme comme un tableau avec le nom de chaque personne, un lien vers plus d'informations à son sujet, et ses catégories de contribution affichées en texte ou en emoji à partir d'une légende définie. La spécification indique que l'ordre est sans importance, que les contributeurs sont des personnes qui contribuent dans n'importe quelle catégorie à n'importe quel niveau, et qu'elle recommande de ne pas exclure une personne de la liste sur la base du niveau de contribution perçu. Au niveau du commit, le trailer Co-authored-by: Name <email> : la documentation de GitHub décrit l'ajout d'une ligne de trailer par coauteur après une ligne vide dans le message de commit, en utilisant une adresse e-mail associée au compte de la personne pour que le commit compte comme sa contribution, ou son adresse no-reply si elle préfère la garder privée.

Pourquoi c'est important

Les journaux de commits ne montrent que le code. Le triage, la documentation, les traductions, la conception, les réponses aux questions, la relecture et le signalement de bugs y restent invisibles, et c'est pourtant ce travail qui garde un petit projet utilisable. La reconnaissance est l'une des rares choses qu'un projet bénévole peut offrir, et elle ne coûte qu'une ligne de tableau. Les classements et les comptages, à l'inverse, récompensent le volume plutôt que l'utilité et découragent la personne qui a corrigé une seule chose importante.

Comment l'appliquer

• Adopter les catégories de la légende emoji de la spécification, ou un sous-ensemble, et préciser dans CONTRIBUTING que chaque type de contribution compte.
• Ajouter une ligne dès la première contribution et demander le nom et le lien préférés ; laisser les personnes la possibilité de refuser d'être listées.
• Créditer les personnes qui signalent des bugs et des failles de sécurité dans le changelog et dans l'avis, pas seulement dans le tableau.
• Utiliser Co-authored-by lorsqu'un changement a été écrit par plus d'une personne, y compris un commit qu'un mainteneur a terminé à partir du brouillon de quelqu'un d'autre ; une personne qui a relu est créditée dans la pull request, pas en tant qu'auteur.
• Ne jamais trier le tableau par quantité, et ne jamais y attacher de scores ou de badges de rang.
• Garder le tableau suffisamment lisible par une machine pour qu'un robot ou un script puisse y ajouter des lignes, afin que la reconnaissance ne dépende pas de la mémoire d'un mainteneur.

Pièges

Lister une adresse e-mail sans avoir demandé. N'ajouter que les personnes dotées d'un compte GitHub et oublier les contributions arrivées par e-mail ou par chat. Un tableau qui cesse d'être mis à jour, ce qui se lit comme une date limite au-delà de laquelle plus personne ne compte.