All Contributors

All Contributors

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

›@all-contributors bot 🤖

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 do Bot

Você pode configurar o comportamento do bot de todos-colaboradores, atualizando o arquivo JSON all-contributorsrc. Os dados utilizados para gerar a lista de colaboradores serão armazenados no mesmo arquivo JSON. Você pode personalizar o @all-contributors-cli para gerar a lista de acordo com suas preferências.

Você está visualizando o 🤖Bot de configuração, que é semelhante à Configuração de CLI

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: JulioSilva123
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.Padrão: false
commitConventionConvenção de commit (angular, atom, ember, eslint, jshint ou gitmoji).Default: angular
contributorsPerLineNúmero máximo de colunas na tabela de contribuidores.Padrão: 7
contributorsSortAlphabeticallytrue: Ordem alfabética.
false: Exibir na ordem que foi adicionado.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.
wrapperTemplateDefina seu próprio modelo de lodash para gerar a lista de colaboradores.
typesEspecificar símbolos personalizados ou modelos de link para os tipos de contribuição. Pode substituir os tipos documentados.
linkToUsageAdiciona um rodapé com link para uso ( true ou false)Padrão: true
skipCiFaz com que o CI ignore o commit. (true ou false)Padrão: true
contributorsLista de contribuidores desse projeto, que é atualizada por @all-contributors add
{
  "projectName": "all-contributors-cli",
  "projectOwner": "JulioSilva123",
  "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": "Um tipo de contribuição customizada.",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "contributors": []
}

Movendo a tabela de todos os colaboradores para um arquivo diferente

Como você sabe, o arquivo padrão para a tabela de colaboradores é README.md. Mas se o seu projeto tem muitos colaboradores, não faz sentido incluir essa lista de todos no arquivo README.md. Ao invés disso, você pode usar um arquivo diferente para fazê-lo.

A seguir, apresentamos os passos que podem auxiliá-lo na criação desse outro arquivo. Para esse tutorial, vamos criar um arquivo e colocar o nome de CONTRIBUTORS.md.

  1. Instale o bot. Consulte a página de Instalação para obter maiores instruções.

  2. Adicione seu primeiro colaborador. Consulte a página de Automação para obter maiores instruções.

  3. Crie o arquivo CONTRIBUTORS.md.

  4. Copie o código que pode ser encontrado nesse guia.

  5. Modifique a chave files no arquivo JSON .all-contributorsrc com nome do arquivo que escolhemos.

    {
    "files": [
      "CONTRIBUTORS.md"
    ],
    ...
    }
    
  6. Agora é só salvar. Novos colaboradores serão adicionados a esse novo arquivo em vez do arquivo README.md.

← UtilizaçãoFAQs →
All Contributors