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ção | Descrição | Exemplo/Padrão |
---|---|---|
projectName | Obrigatório, nome do projeto. | Exemplo: todos os contribuidores-cli |
projectOwner | Obrigatório, nome do usuário em que o projeto está hospedado. | Exemplo: JulioSilva123 |
repoType | Tipo de repositório. Deve ser github ou gitlab . | Padrão: github |
repoHost | Nome 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 |
files | Lista the arquivos a actualizar. | Padrão: ['README.md'] |
imageSize | Tamanho (em px) do avatar do usuário. | Padrão: 100 |
commit | Opção de commitar automaticament ao adicionar novos contribuidores. | Padrão: false |
commitConvention | Convenção de commit (angular , atom , ember , eslint , jshint ou gitmoji ). | Default: angular |
contributorsPerLine | Número máximo de colunas na tabela de contribuidores. | Padrão: 7 |
contributorsSortAlphabetically | true : Ordem alfabética. | |
false : Exibir na ordem que foi adicionado. | 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. | |
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 | Adiciona um rodapé com link para uso ( true ou false ) | Padrão: true |
skipCi | Faz com que o CI ignore o commit. (true ou false ) | Padrão: true |
contributors | Lista 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": "[](#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
.
Instale o bot. Consulte a página de Instalação para obter maiores instruções.
Adicione seu primeiro colaborador. Consulte a página de Automação para obter maiores instruções.
Crie o arquivo
CONTRIBUTORS.md
.Copie o código que pode ser encontrado nesse guia.
Modifique a chave
files
no arquivo JSON.all-contributorsrc
com nome do arquivo que escolhemos.{ "files": [ "CONTRIBUTORS.md" ], ... }
Agora é só salvar. Novos colaboradores serão adicionados a esse novo arquivo em vez do arquivo
README.md
.