Edit

CLIの使い方

この使用方法に関するマニュアルでは、cliのインストール手順を終えていることを前提としています。

簡単な注意: 以下では、単純にするために<コード>all-contributorsを使用しますが、もし何か問題があれば、all-contributors<コード>の方を試してみてください 😺

コマンド

all-contributors init

all-contributors-cliの使い始めるときに実行する。 このコマンドは、いくつかの質問を行い、all-contributorsに対してプロジェクトを設定します。 この設定では、.all-contributorsrc設定ファイルを作成し、指定したファイル (たいていはREADME.md) にコントリビューターテーブルを作成します。

all-contributors add

プロジェクトに新しいコントリビューターを追加したり、コントリビュートした方法を追加するには、addを使用します。 コントリビューターが設定ファイルに加えられると、生成コマンドを使用したときと同じように、コントリビューターファイルを更新します。

# <contribution>タイプのコントリビューションを行った新しいコントリビューター<username>を追加する
all-contributors add <username> <contribution>
# 例:
all-contributors add jfmengels code,doc

ここでは、usernameGitHubやGitlabのユーザー名であり、contributionはコントリビューションの,-区切りのリストです。 有効なcontributionタイプのリストについてはEmoji キー(コントリビューションタイプのリファレンス)を参照してください。

GitLabユーザー: 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.

GitHub API制限のためこのコマンドはコントリビューターが500よりも少ないプロジェクトにおいてのみ機能します (GitHubユーザー下部で述べるように、PRIVATE_TOKENを設定しない限り)。

all-contributors generate

generateを使用して、 .all-contributorsrcファイルからcontributorsリストを読み込み、 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 -->

GitHubユーザー

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.

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.

プライベートトークンは、GitLab APIの認証するためのパーソナルアクセストークンです。

# Linux上でprivate tokenを設定する
export PRIVATE_TOKEN=your_private_token
# Windows上でprivate tokenを設定する
set PRIVATE_TOKEN=your_private_token

次は？

← インストール設定 →