Edit

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 to compare contributors from GitHub with the ones credited in your .all-contributorsrc file, to make sure that credit is given where it's due.

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_TOKEN como 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.

Please note the command must be able to find the following tags in those files, to update the table:

<!-- 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 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. You may need to set an environment variable named PRIVATE_TOKEN to circumvent this GitHub rate limit.

Private token is your Personal Access Token (PAT) to authenticate with the GitHub API.

Usuarios de GitLab

Please note that if you are using a self-hosted GitLab instance, some commands will need you to set an environment variable named PRIVATE_TOKEN first.

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

¿Qué sigue?

← InstalaciónConfiguración →