Especificación
Un ejemplo de cómo utilizar las especificaciones de la Tabla de todos los Colaboradores para reconocer todos los colaboradores
Obligatorio
Los proyectos de código abierto deben incluir los siguientes elementos obligatorios para admitir la especificación Todos los Colaboradores:
- 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. En muchos casos, este es el archivo README del proyecto
- 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"
- 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).
- Un enlace a la Categoría de contribución en formato de texto o emoji usando las Categorías de contribución definidas y / o emoji de Categorías de contribución.
- La lista de colaboradores se puede distribuir en varias líneas (cada una técnicamente es su propia tabla) según sea necesario.
- El orden de los colaboradores es irrelevante para la especificación. Ordénalos como desees.
- 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. En los casos en que los proyectos se desvíen de las categorías de contribución o requieran un nivel de contribución específico para cumplir con los criterios como colaboradores del proyecto, el proyecto debe proporcionar documentación explícita de las definiciones que satisfacen los criterios del colaborador del proyecto en el documento CONTRIBUTING o en un documento público similar que sea destacado en el nivel superior del repositorio del proyecto. 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.
Pro tip: Puede utilizar el @all-contributors bot 🤖 para automatizar el reconocimiento de los colaboradores de tus proyectos de código abierto ✨
Opcional
Los proyectos deben considerar los siguientes elementos opcionales como parte de su compromiso con la especificación Todos los Colaboradores:
- El avatar del usuario puede ser incluido y se recomienda.
- 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.