Edit

CLIのインストール

1. CLI ツールをインストール

このモジュールはnodeでバンドルされnpmで入手できます。また、プロジェクトのdevDependenciesのひとつとしてインストールする必要があります:

yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli

または、Arch Linuxユーザーは、AURから all-contributors-cli パッケージをインストールすることができます。

The CLI is node based, if you don't wish to add a node dependency use the @all-contributors bot 🤖

2. プロジェクトの初期化

initでプロジェクトを初期化し、いくつかの質問に答えます

yarn all-contributors init # npm run

# または直接バイナリを実行
./node_modules/.bin/all-contributors init

3. コントリビューターを追加

yarn all-contributors add jfmengels doc
yarn all-contributors generate

コマンドの詳細についてはCLIの使い方を参照してください。

4. コントリビューションドキュメントを更新

コントリビューターが自身を追加できるように、 CONTRIBUTING.mdまたは同様の手順を更新してください。 cliの使い方に関するドキュメントにリンクすることもできます。

5. 任意でpackage.jsonにショートカットスクリプトを追加

任意で、package.jsonのscriptsフィールドにショートカットコマンドを追加できます。

例:

{
  "scripts": {
    "contributors:add": "all-contributors add",
    "contributors:generate": "all-contributors generate"
  }
}

次のようなショートカットが可能になります

yarn contributors:add jfmengels doc

次は？

• CLIの使い方
• CLIの設定