Edit

Использование CLI

Документация по использованию предполагает, что вы уже выполнили установку CLI.

Быстрая заметка: ниже мы приведём упрощённые примеры команды all-contributors, но если у Вас возникли какие-либо трудности, попробуйте воспользоваться командой yarn all-contributors 😺

Команды

all-contributors init

Запустите эту команду при первом запуске all-contributors-cli. Эта команда задаст несколько вопросов и установит проект для all-contributors. Эта настройка включает создание файла конфигурации .all-contributorsrc и создание таблицы для участников в files, который вы указали (обычно это README.md).

all-contributors add

Используйте add для добавления новых участников в Ваш проект или добавьте новые типы, в которых они внесли свой вклад. Они будут добавлены в конфигурационный файл, а файл участников будет обновлен так же, как если бы Вы использовали команду generate command.

# Добавить нового участника <username>, который внёс вклад типа <contribution>
all-contributors add <username> <contribution>
# Пример:
all-contributors add jfmengels code,doc

Где username – имя пользователя на GitHub или Gitlab, а contribution – список типов вкладов через запятую. Смотрите Emoji Key (ссылка на типы вкладов) для списка допустимых типов contribution.

Пользователям 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 участников (пока Вы не установите PRIVATE_TOKEN, как упомянуто ниже).

all-contributors generate

Используйте generate для чтения contributors из вашего списка .all-contributorsrc файла и обновления таблиц участников, указанных в files ключе.

Please note the command must be able to find the following tags in those files, to update the table:

<!-- ALL-CONTRIBUTORS-LIST:START – Не удаляйте и не изменяйте эту секцию -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Also, note that it needs to find the following tags to update the badge:

<!-- ALL-CONTRIBUTORS-BADGE:START - Не удаляйте и не изменяйте эту секцию -->
<!-- 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
export PRIVATE_TOKEN=ваш_приватный_токен
# установить приватный токен для Windows
set PRIVATE_TOKEN=ваш_приватный_токен

Дальше

← УстановкаКонфигурация →