All Contributors

All Contributors

  • Документация
  • GitHub
  • Languages iconРусский
    • English
    • 日本語
    • Deutsch
    • Español
    • Français
    • Bahasa Indonesia
    • 한국어
    • Polski
    • Português (Brasil)
    • 中文

›CLI

Спецификация

  • Обзор
  • Спецификация
  • Emoji Ключ ✨
  • Repository Maintainers
  • Инструменты

@all-contributors Бот 🤖

  • Обзор
  • Установка
  • Использование
  • Конфигурация
  • FAQs

CLI

  • Обзор
  • Установка
  • Использование
  • Конфигурация

Проект

  • Помогите нам улучшить
  • Кодекс поведения
  • Кто этим пользуется?
Edit

Конфигурация CLI

Вы можете настроить all-contributors, изменяя JSON .all-contributorsrc файл. Данные, используемые для генерации списка участников, будут сохранены в этом файле, и Вы можете настроить all-contributors-cli для генерации списка как Вам угодно.

Вы просматриваете CLI-конфигурацию, ищете конфигурацию бота?

Ниже приведены ключи, которые можно задать:

ОпцияОписаниеПример/По-умолчанию
projectNameОбязательно, имя проекта.Пример: all-contributors-cli
projectOwnerОбязательно, имя пользователя, на котором размещается проект.Пример: jfmengels
repoTypeТип репозитория. Должно быть github или gitlab.По умолчанию: github
repoHostУказывает имя хоста репозитория. Измените его, если вы используете собственный репозиторий.По умолчанию: https://github.com если repoType является github, и https://gitlab.com если repoType является gitlab
filesМассив файлов для обновления.По умолчанию: ['README.md']
imageSizeРазмер аватара пользователя (в пикселях).По умолчанию: 100
commitАвтоматически коммитить значек (badge) при добавлении участников.true или false
commitConventionСоглашение слияния изменений (angular, atom, ember, eslint, jshint или gitmoji).По умолчанию: none
contributorsPerLineМаксимальное количество столбцов для таблицы участников.По умолчанию: 7
contributorsSortAlphabeticallytrue: Sort alphabetically. false: Display in order of addition.Default: false
badgeTemplateУстанавливает пользовательский шаблон lodash для генерации значка.
contributorTemplateУстанавливает пользовательский шаблон lodash для генерации участника.
typesУказывает пользовательские символы или шаблоны ссылок для типов вкладов. Может переопределять документированные типы.
contributorsСписок участников этого проекта, обновляется при @all-contributors add
{
  "projectName": "all-contributors-cli",
  "projectOwner": "jfmengels",
  "repoType": "github",
  "repoHost": "https://github.com",
  "files": ["README.md"],
  "imageSize": 100,
  "commit": false,
  "contributorsPerLine": 7,
  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)",
  "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
  "types": {
    "custom": {
      "symbol": "🔭",
      "description": "A custom contribution type.",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "contributors": []
}
← ИспользованиеПомогите нам улучшить →
All Contributors