CLI Installation
1. Install the CLI tool
Dieses Modul wird über npm verteilt, das mit Node gebündelt ist, und sollte als eines der devDependencies des Projekts installiert werden:
yarn add --dev all-contributors-cli # oder npm i -D all-contributors-cli
Alternatively, Arch Linux users can install the all-contributors-cli package from the AUR.
The CLI is node based, if you don't wish to add a node dependency use the @all-contributors bot 🤖
2. Initialisieren des Projekts
Initialisiere das Projekt mittels init und beantworte einige Fragen
yarn all-contributors init # or npx all-contributors init
# Oder führe die bin-Datei direkt aus
./node_modules/.bin/all-contributors init
3. Einige Mitwirkende hinzufügen
yarn all-contributors add jfmengels doc
yarn all-contributors generate
Weitere Informationen zu den Befehlen findest Du im Kapitel CLI Nutzung
4. Aktualisieren der Mitwirkenden Dokumentation
Beschreibe, wenn immer möglich, in der CONTRIBUTING.md Datei oder an einem anderen geeigneten Ort wie sich Mitwirkende an Deinem Projekt zur Liste der Mitwirkenden hinzufügen können. Du kannst auch auf die Dokumentation zur Nutzung des CLI verweisen.
5. Optional kannst du Kurzschreibweisen in deiner package.json Datei definieren
Du kannst optional Kurzschreibweisen (shortcut scripts) im Abschnitt scripts deiner package.json Datei definieren.
Zum Beispiel:
{
"scripts": {
"contributors:add": "all-contributors add",
"contributors:generate": "all-contributors generate"
}
}
Dies erlaubt Kurzschreibweisen wie
yarn contributors:add jfmengels doc