Uso de la interfaz de línea de comandos
Esta documentación de uso asume que usted ya siguió los pasos de instalación de la cli.
Una nota rápida: a continuación, solo mostraremos all-contributors para simplificar las cosas, pero si está teniendo alguna dificultad, entonces pruebe la ruta yarn all-contributors 😺
Comandos
all-contributors init
Ejecute esto cuando empiece a usar la all-contributors-cli. Este comando hace algunas preguntas y configura el proyecto para all-contributors. Esta configuración incluye la creación de un archivo de configuración .all-contributorsrc y la creación de una tabla de colaboradores en los archivos que especifique (generalmente su README.md).
all-contributors add
Use add para agregar nuevos colaboradores a su proyecto, o agregue nuevas formas en las que hayan colaborado. Se agregarán a su archivo de configuración, y el archivo de colaboradores se actualizará como si usara el comando generar.
# Add new contributor <username>, who made a contribution of type <contribution>
all-contributors add <username> <contribution>
# Example:
all-contributors add jfmengels code,doc
Donde username es el nombre de usuario del usuario en Github o Gitlab, y contribution es una lista de colaboraciones separadas por , (coma). Consulte la Emoji Key (referencia de tipos de contribución) para obtener una lista de los tipos de contribution válidos.
Usuarios de Gitlab: consulte los requisitos adicionales para los usuarios de GitLab
all-contributors check
Use check para comparar a los colaboradores de Github con los acreditados en su archivo .all-contributorsrc, para asegurarse de que se otorga el crédito a donde se debe.
Debido a restricciones en la API de Github, este comando solo funciona para proyectos con menos de 500 colaboradores (a menos que usted use un
PRIVATE_TOKENcomo se menciona abajo en usuarios de Github).
all-contributors generate
Use generate para leer la lista de contributors de su archivo .all-contributorsrc y actualizar las tablas de contribuyentes especificadas por la clave files.
Tenga en cuenta que el comando debe poder encontrar las siguientes etiquetas en esos archivos, para poder actualizar la tabla:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
Also note that it needs to find the following tags in order to update the badge:
<!-- ALL-CONTRIBUTORS-BADGE:START - No eliminar o modificar esta sección -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->
Usuarios de GitHub
En algunos casos, podría ver el mensaje de error: GitHub API rate limit exceeded for xxx. Es posible que deba usar una variable de entorno llamada PRIVATE_TOKEN para evitar el límite de frecuencia (rate limit) de Github.
El token privado es su token de acceso personal para autenticar con la API de Github.
Usuarios de GitLab
Tenga en cuenta que si está usando una instancia de Gitlab auto alojada, algunos comandos necesitarán que use primero una variable de entorno llamada PRIVATE_TOKEN.
El token privado es el token de acceso personal para autenticar con la API de Gitlab.
# establecer token privado en Linux
export PRIVATE_TOKEN=your_private_token
# establecer token privado en Windows
set PRIVATE_TOKEN=your_private_token