Installation de l'invité de commande
1. Installer l'outil de ligne de commande
Ce module est distribué via npm qui est groupé avec node et devrais être installé comme l'une des dépendance de développement de votre projet:
yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli
De manière alternative, les utilisateurs d'Arch Linux peuvent installer le paquet all-contributors-cli de l'AUR.
The CLI is node-based, if you don't wish to add a node dependency use the @all-contributors bot 🤖
2. Initialisez le projet
Initialisez le projet en utilisant init et en répondant à quelques questions
yarn all-contributors init # ou npx all-contributors init
# Ou exécutez directement le bin
./node_modules/.bin/all-contributors init
3. Ajoutez quelques contributeurs
yarn all-contributors add jfmengels doc
yarn all-contributors generate
Pour plus d'info sur les commandes, voyez l'usage d'invité de commande
4. Mettez à jour votre document de Contribution
Considerez mettre à jour votre CONTRIBUTING.md ou similaire avec des étapes sur la façon dont des contributeurs peuvent s’ajouter eux-mêmes. Vous pouvez même lier a ladocumentation d'utilisation de l'invité de commande.
5. Optionellement ajoutez des scripts raccourcis à votre package.json
Vous pouvez éventuellement ajouter des raccourcis à vos commandes dans votre champ scripts dans votre package.json.
Par exemple :
{
"scripts": {
"contributors:add": "all-contributors add",
"contributors:generate": "all-contributors generate"
}
}
Pour permettre des raccourcis tels que
yarn contributors:add jfmengels doc