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 contribuintes serão armazenados lá dentro, e você pode configurar como você quer @all-contributors
para gerar a lista.
Você está visualizando o 🤖Bot de configuração, que é semelhante à Configuração de CLI
Estas são as chaves que pode especificar:
Opção | Descrição | Exemplo/Padrão |
---|---|---|
files | Lista the arquivos a actualizar. | Padrão: ['README.md'] |
imageSize | Tamanho (em px) do avatar do usuário. | Padrão: 100 |
contributorsPerLine | Número máximo de colunas na tabela de contribuidores. | Padrão: 7 |
contributorsSortAlphabetically | true : Sort alphabetically. false : Display in order of addition. | Padrão: 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. | |
types | Especificar símbolos personalizados ou modelos de link para os tipos de contribuição. Pode substituir os tipos documentados. | |
skipCi | Faz o CI ignorar o commit. (tanto true ou false ) | Padrão: true |
contributors | Lista de contribuidores desse projeto, que é atualizada por @all-contributors add |
{
"files": ["README.md"],
"imageSize": 100,
"contributorsPerLine": 7,
"contributorsSortAlphabetically": false,
"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 customizado.",
"link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
}
},
"skipCi": "true",
"contributors": []
}
Moving the All Contributors table into a different file
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. Instead, you can use a different file to do so.
Here are the steps that may help you in achieving that. For the sake of this tutorial, the different file that we'll use is going to be named CONTRIBUTORS.md
.
Install the bot. See the Installation page for instructions.
Add your first contributor. See the Bot Usage page for instructions.
Create the
CONTRIBUTORS.md
file.Copy the code from the Contributors section in the
README.md
file, starting at theALL-CONTRIBUTORS-LIST:START
line, and ending at theALL-CONTRIBUTORS-LIST:END
line.Example:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center">...</td> </tr> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->
Modify the
files
key in the.all-contributorsrc
JSON file to match your new file name.{ "files": [ "CONTRIBUTORS.md" ], ... }
Now you should be good to go. New contributors will be added to this new file instead of the
README.md
file.