Reconhecer contribuidores: uma tabela por tipo de contribuição, sem rankings

O que é

São dois mecanismos complementares. No nível do projeto, a especificação All Contributors: uma seção Contributors na documentação mais visível (normalmente o README, ou um arquivo CONTRIBUTORS com link a partir dele quando a lista cresce), formatada como uma tabela com o nome de cada pessoa, um link para mais informações sobre ela e suas categorias de contribuição, indicadas em texto ou emoji a partir de uma legenda definida. A especificação afirma que a ordem é irrelevante, que contribuidores são pessoas que contribuem em qualquer categoria e em qualquer nível, e que recomenda não excluir ninguém da lista com base no nível de contribuição percebido. No nível do commit, o trailer Co-authored-by: Name <email>: a documentação do GitHub descreve a inclusão de uma linha de trailer por coautor, após uma linha em branco na mensagem do commit, usando um endereço de e-mail associado à conta da pessoa para que o commit conte como contribuição dela, ou o endereço no-reply, caso ela mantenha o e-mail privado.

Por que importa

O histórico de commits mostra apenas código. Triagem, documentação, traduções, design, resposta a dúvidas, revisão e relato de bugs ficam invisíveis ali, e esse é o trabalho que mantém um projeto pequeno utilizável. O reconhecimento é uma das poucas coisas que um projeto voluntário pode oferecer, e custa apenas uma linha na tabela. Já rankings e contagens premiam o volume em vez da utilidade e desencorajam quem corrigiu uma única coisa importante.

Como aplicar

• Adote as categorias da legenda de emojis da especificação, ou um subconjunto delas, e declare no CONTRIBUTING que todo tipo de contribuição conta.
• Adicione uma linha na primeira contribuição e pergunte qual nome e link a pessoa prefere; permita que ela recuse constar na lista.
• Dê crédito a quem relata bugs e problemas de segurança no changelog e no aviso de segurança (advisory), e não só na tabela.
• Use Co-authored-by quando uma mudança for escrita por mais de uma pessoa, inclusive em um commit que um mantenedor concluiu a partir do rascunho de outra pessoa; quem fez a revisão recebe crédito no pull request, não como autor.
• Nunca ordene a tabela por quantidade e nunca associe pontuações ou selos de classificação.
• Mantenha a tabela legível por máquina o bastante para que um bot ou script possa adicionar linhas, de modo que o reconhecimento não dependa de o mantenedor se lembrar.

Armadilhas

Listar um endereço de e-mail sem perguntar. Incluir apenas pessoas com conta no GitHub e esquecer contribuições que chegaram por e-mail ou chat. Uma tabela que deixa de ser atualizada, o que passa a impressão de uma data de corte para quem importou.