Configuração do Bot

You can configure the all-contributors bot behaviour by updating the .all-contributorsrc JSON file. The data used to generate the contributors list will be stored there, and you can configure how you want @all-contributors to generate the list.

You are viewing the 🤖Bot Configuration, which is similar to the CLI Configuration

Estas são as chaves que pode especificar:

Opção	Descrição	Exemplo/Padrão
`projectName`	Obrigatório, nome do projeto.	Example: `all-contributors-cli`
`projectOwner`	Obrigatório, nome do usuário em que o projeto está hospedado.	Example: `tenshiAMD`
`repoType`	Tipo de repositório. Must be either `github` or `gitlab`.	Default: `github`
`repoHost`	Nome do host do repositório. Mude-o se usar um repositório auto-hospedado.	Default: `https://github.com` if `repoType` is `github`, and `https://gitlab.com` if `repoType` is `gitlab`
`files`	Lista the arquivos a actualizar.	Default: `['README.md']`
`imageSize`	Tamanho (em px) do avatar do usuário.	Default: `100`
`commit`	Opção de commitar automaticament ao adicionar novos contribuidores.	Default: `false`
`commitConvention`	Commit convention (`angular`, `atom`, or `none`).	Default: `angular`
`commitType`	Set the `type` for the commit in your chosen `commitConvention` (read more at Conventional Commits specification.	Default: `docs`
`contributorsPerLine`	Número máximo de colunas na tabela de contribuidores.	Default: `7`
`contributorsSortAlphabetically`	`true`: Sort alphabetically. `false`: Display in order of addition.	Default: `false`
`badgeTemplate`	Defina o próprio modelo de lodash para gerar o badge.
`contributorTemplate`	Defina o próprio modelo de lodash para gerar o contribuidor.
`wrapperTemplate`	Defina seu próprio modelo de lodash para gerar a lista de colaboradores.
`types`	Especificar símbolos personalizados ou modelos de link para os tipos de contribuição. Pode substituir os tipos documentados.
`linkToUsage`	Adds a footer with link to usage (either `true` or `false`)	Default: `true`
`skipCi`	Faz com que o CI ignore o commit. (either `true` or `false`)	Default: `true`
`contributors`	List of contributors for this project, this is updated by @all-contributors add

{
  "projectName": "all-contributors",
  "projectOwner": "all-contributors",
  "repoType": "github",
  "repoHost": "https://github.com",
  "files": ["README.md"],
  "imageSize": 100,
  "commit": false,
  "contributorsPerLine": 7,
  "contributorsSortAlphabetically": false,
  "badgeTemplate": "[![All Contributors](https://img.shields.io/github/all-contributors/<%= projectOwner %>/<%= projectName %>?color=ee8449&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>",
  "wrapperTemplate": "\n<table>\n  <tbody><%= bodyContent %>  </tbody>\n<%= tableFooterContent %></table>\n\n",
  "types": {
    "custom": {
      "symbol": "🔭",
      "description": "A custom contribution type.",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "linkToUsage": true,
  "skipCi": true,
  "commitType": "docs",
  "contributors": []
}

Movendo a tabela de todos os colaboradores para um arquivo diferente

As you know, the default file for the contributors table is README.md. But if your project has tons of contributors, it doesn’t make sense to include the All Contributors table in the README.md file. 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. For the sake of this tutorial, the different file that we’ll use is going to be named CONTRIBUTORS.md.

Instale o bot. See the Installation page for instructions.
Adicione seu primeiro colaborador. See the Bot Usage page for instructions.
Create the CONTRIBUTORS.md file.
Copy the code which can be found in this guide.
Modify the files key in the .all-contributorsrc JSON file to match your new file name.
.all-contributorsrc
```
{
    "files": [
        "CONTRIBUTORS.md"
    ],
    ...
}
```
Agora é só salvar. New contributors will be added to this new file instead of the README.md file.