Edit

Установка CLI

1. Установите инструмент CLI

Версия NPM Версия AUR

Этот модуль доступен через npm, который идёт в комплекте с node и должен быть установлен в один из ваших проектов как devDependencies:

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

В качестве альтернативы, пользователи Arch Linux могут установить пакет all-contributors-cli из AUR.

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 # или npx all-contributors init 

# Или запустите непосредственно bin
./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

Дальше

← ОбзорИспользование →