Reconocimiento de colaboradores: una tabla de colaboradores por tipo de contribución, sin clasificaciones

Qué es

Dos mecanismos complementarios. A nivel de proyecto, la especificación All Contributors: una sección de colaboradores en la documentación más destacada (habitualmente el README, o un archivo CONTRIBUTORS enlazado desde él cuando la lista crece), presentada como una tabla con el nombre de cada persona, un enlace con más información sobre ella y sus categorías de contribución mostradas como texto o emoji según una clave definida. La especificación establece que el orden no importa, que los colaboradores son personas que contribuyen en cualquier categoría y en cualquier nivel, y que recomienda no excluir a nadie de la lista por un nivel de contribución percibido como bajo. A nivel de commit, el trailer Co-authored-by: Name <email>: la documentación de GitHub describe cómo añadir una línea de trailer por cada coautor tras una línea en blanco en el mensaje del commit, usando una dirección de correo asociada a la cuenta de la persona para que el commit cuente como su contribución, o su dirección no-reply si mantiene la suya privada.

Por qué importa

Los registros de commits solo muestran código. El triage, la documentación, las traducciones, el diseño, la respuesta a preguntas, la revisión y el reporte de errores son invisibles allí, y son el trabajo que mantiene usable a un proyecto pequeño. El reconocimiento es una de las pocas cosas que un proyecto voluntario puede dar, y cuesta una fila de tabla. Las clasificaciones y los recuentos, en cambio, premian el volumen por encima de la utilidad y desalientan a quien corrigió una sola cosa importante.

Cómo aplicarlo

• Adoptar las categorías de la clave de emoji de la especificación, o un subconjunto, e indicar en CONTRIBUTING que todo tipo de contribución cuenta.
• Añadir una fila en la primera contribución y solicitar el nombre y el enlace preferidos; permitir que alguien decline aparecer en la lista.
• Reconocer a quienes reportan errores y vulnerabilidades de seguridad en el changelog y en el aviso correspondiente, no solo en la tabla.
• Usar Co-authored-by cuando un cambio fue escrito por más de una persona, incluido un commit que quien mantiene el proyecto terminó a partir del borrador de otra persona; a quien revisó se le reconoce en el pull request, no como autor.
• Nunca ordenar la tabla por cantidad, ni adjuntar puntuaciones o insignias de rango.
• Mantener la tabla lo bastante legible por máquina para que un bot o un script pueda añadir filas, de modo que el reconocimiento no dependa de que alguien lo recuerde.

Trampas

Indicar una dirección de correo sin pedir permiso. Añadir solo a quienes tienen cuenta de GitHub y olvidar las contribuciones que llegaron por correo o chat. Una tabla que deja de actualizarse, que se lee como una fecha de corte de quién importó.