Especificación

Un ejemplo de cómo utilizar las especificaciones de la Tabla de todos los Colaboradores para reconocer todos los colaboradores

Obligatorio

Open source projects should include the following mandatory items to support the All Contributors specification:

1. Una sección de “Colaboradores” en un sitio destacado de la documentación del repositorio del proyecto que incluye una lista de todos los colaboradores del proyecto
   • El objetivo debe ser utilizar el sitio más destacado de la documentación del proyecto cuando sea posible. In many cases, this is the project README.md file
   • 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. En este caso, un enlace destacado al archivo CONTRIBUTING debe incluirse en la página README bajo el encabezado “Colaboradores”
2. Los listados deben tener el formato de tabla con la siguiente información sobre los colaboradores del proyecto:
   • Nombre
   • Enlace de URL a un sitio donde se puede obtener más información sobre el colaborador. Esta URL puede ser determinada por el colaborador del proyecto a discreción.
   • Una indicación de la categoría de contribución en formato de texto o icono en formato de imagen utilizando las categorías de contribución definidas y / o las imágenes de emoji de categorías de contribución (ver más abajo).
   • A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or Contribution Categories emoji.
     • The list of contributors can be spread across multiple lines (each technically being its table) as needed.
     • El orden de los colaboradores es irrelevante para la especificación. Ordénalos como desees.
3. Los proyectos deben definir a los colaboradores como aquellos que contribuyen a un proyecto en cualquiera de las categorías de contribución en cualquier nivel de contribución. Esta especificación incluye, por definición, todas las contribuciones. 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. Esta especificación recomienda que no se excluya a un individuo de la lista de colaboradores en función del nivel percibido de contribución. En su lugar, los proyectos deben usar indicadores de esfuerzo dentro de una lista que incluya a todos los colaboradores al proyecto en cualquier nivel de esfuerzo. Si se utilizan, estos indicadores de esfuerzo quedan a discreción del proyecto y no se especifican actualmente.

Consejo

You can use the @all-contributors bot 🤖 to automate acknowledging contributors to your open source projects ✨

Opcional

Los proyectos deben considerar los siguientes elementos opcionales como parte de su compromiso con la especificación Todos los Colaboradores:

1. El avatar del usuario puede ser incluido y se recomienda.
2. Se puede incluir un enlace opcional desde el indicador de Categoría de contribución a la(s) contribución(es) específica(s) para proporcionar información adicional sobre la(s) contribución(es) del proyecto, tal como se detalla en la siguiente sección.