Utilisation de l'invité de commande

Cette documentation d’utilisation suppose que vous avez déjà suivi les étapes d’installation de l'invité de commande.

Note rapide: Ci-dessous on vas juste montrer all-contributors pour rendres les choses simple, mais si vous avez des difficultées, essayer la route yarn all-contributors 😺

`all-contributors init`

Exécutez ceci lorsque vous commencez à utiliser all-contributors-cli. Cette commande demande quelques questions et met en place le projet pour all-contributors. Cette configuration comprend la création d’un fichier de configuration .all-contributorsrc et la création d’une table de contributeur dans les fichers que vous spécifiez (habituellement votre README.md).

`all-contributors add`

Utilisation add pour ajouter de nouveaux contributeurs à votre projet, ou ajouter des nouvelles façons dans laquelle ils/elles ont contribué . Ils seront ajoutés à votre fichier de configuration, et les contributeurs de fichier mettra à jour tout comme si vous utilisiez la commande generate.

# Ajouter un nouveau contributeur <nom_utilisateur>, qui a fait une contribution de type <contribution>
all-contributeurs add <nom_utilisateur> <contribution>
# exemple :
all-contributeurs add jfmengels code, doc

Où nom_utilisateur est le nom GitHub ou Gitlab de l’utilisateur et la contribution est une liste de contributions séparées par ,. Voir les Clé Emoji (Réference de Types de Contribution) pour obtenir la liste de types de contribution valable.

Utilisateurs GitLab: voir les conditions supplémentaires pour les utilisateurs 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.

En raison des restrictions de l'API GitHub, cette commande ne fonctionne que pour les projets avec moins de que 500 contributeurs (sauf si vous définissez un PRIVATE_TOKEN comme mentionné ci-dessous dans les utilisateurs GitHub).

`all-contributors generate`

Utilisez generate pour lire la liste de contributeurs de votre fichier .all-contributorsrc et pour mettre à jour les tableaux de contributeur spécifiés par la clé 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 - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Utilisateurs de GitHub

Dans certain cas vous pourrez voir le message d'erreur 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.

Utilisateurs de GitHub

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.

Private Token est votre jeton d'accès personel pour authentifier avec l'IPA de GitHub.

# définir un jeton privé sur Linux
exporter PRIVATE_TOKEN=votre_private_token
# définir un jeton privé sur Windows
définir PRIVATE_TOKEN=votre_private_token

Et ensuite

Configurer l'invité de commande