All Contributors

All Contributors

  • Docs
  • GitHub
  • Languages iconPortuguês (Brasil)
    • English
    • 日本語
    • Deutsch
    • Español
    • Français
    • Bahasa Indonesia
    • 한국어
    • Polski
    • Русский
    • 中文

›CLI

Especificação

  • Visão geral
  • Especificação
  • Tabela de Emoji ✨
  • Mantenedores de Repositório
  • Ferramentas

@all-contributors bot 🤖

  • Visão geral
  • Instalação
  • Utilização
  • Configuração
  • FAQs

CLI

  • Visão geral
  • Instalação
  • Utilização
  • Configuração

Projeto

  • Ajude a melhorar
  • Código de Conduta
  • Quem está usando?
Edit

Configuração de CLI

Pode configurar o all-contibuters actualizando o arquivo JSON .all-contributorsrc. Os dados utilizados para gerar a lista de contribuidores serão armazenados aí, e pode configurar como quer que o all-contributors-cli gere a lista.

Está vendo a Configuração do CLI, procurando a Configuração do Bot?

Estas são as chaves que pode especificar:

OpçãoDescriçãoExemplo/Padrão
projectNameObrigatório, nome do projeto.Exemplo: todos os contribuidores-cli
projectOwnerObrigatório, nome do usuário em que o projeto está hospedado.Exemplo: jfmengels
repoTypeTipo de repositório. Deve ser github ou gitlab.Padrão: github
repoHostNome do host do repositório. Mude-o se usar um repositório auto-hospedado.Padrão: https://github.com se o repoType for github, e https://gitlab.com se o repoType for gitlab
filesLista the arquivos a actualizar.Padrão: ['README.md']
imageSizeTamanho (em px) do avatar do usuário.Padrão: 100
commitOpção de commitar automaticament ao adicionar novos contribuidores.true ou false
commitConventionConvenção de commit (angular, atom, ember, eslint, jshint ou gitmoji).Padrão: nenhum
contributorsPerLineNúmero máximo de colunas na tabela de contribuidores.Padrão: 7
contributorsSortAlphabeticallytrue: Sort alphabetically. false: Display in order of addition.Padrão: false
badgeTemplateDefina o próprio modelo de lodash para gerar o badge.
contributorTemplateDefina o próprio modelo de lodash para gerar o contribuidor.
typesEspecificar símbolos personalizados ou modelos de link para os tipos de contribuição. Pode substituir os tipos documentados.
contributorsLista de contribuidores para este projeto, isto é atualizado ao rodar 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": []
}
← UtilizaçãoAjude a melhorar →
All Contributors