Configuración del bot
Puede configurar El bot all-contribuitors actualizando el archivo JSON .all-contributorsrc
Archivo JSON. Los datos utilizados para generar la lista de contribuidores se almacenará allí, y tú puedes configurar como quieres que@all-contributors
genere la lista.
Usted está viendo la bot configuración 🤖, que es similar a la de configuración CLI
Estas son las claves que puede especificar:
Opción | Descrición | Ejemplo/Defecto |
---|---|---|
files | Arreglo (o vector) de archivos para actualizar. | Defecto: ['README.md'] |
imageSize | Tamaño (en px) del avatar del usuario. | Defecto: 100 |
contributorsPerLine | Número máximo de columnas para la tabla de colaboradores. | Defecto: 7 |
contributorsSortAlphabetically | true : Ordena alfabéticamente. false : Mostar por orden de contribución. | Por defecto: false |
badgeTemplate | Defina su propia plantilla de lodash para generar la insignia. | |
contributorTemplate | Defina su propia plantilla de lodash para generar el colaborador. | |
types | Especifique símbolos personalizados o plantillas de enlaces para los tipos de contribución. Puede anular los tipos documentados. | |
skipCi | Hace que el CI ignore la confirmación. (Puede ser verdadero o falso ) | Predeterminado: verdadero |
contributors | Lista de los colaboradores de este proyecto, este se actualiza 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": "A custom contribution type.",
"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.