Ir al contenido

Configuración del 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 son las claves que puede especificar:

Opción Descrición Ejemplo/Defecto
projectName Obligatorio, nombre del proyecto. Example: all-contributors-cli
projectOwner Obligatorio, nombre del usuario que aloja el proyecto. Example: tenshiAMD
repoType Tipo de repositorio. Must be either github or gitlab. Default: github
repoHost Apunta al nombre de host del repositorio. Cámbiala si usas un repositorio auto alojado. Default: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab
files Arreglo (o vector) de archivos para actualizar. Default: ['README.md']
imageSize Tamaño (en px) del avatar del usuario. Default: 100
commit Insignia de auto-commit al agregar colaboradores. 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 columnas para la tabla de colaboradores. Default: 7
contributorsSortAlphabetically true: Sort alphabetically. false: Display in order of addition. Default: false
badgeTemplate Defina su propia plantilla de lodash para generar la insignia.
contributorTemplate Defina su propia plantilla de lodash para generar el colaborador.
wrapperTemplate Define your own lodash template to wrap the list of contributors
types Especifique símbolos personalizados o plantillas de enlaces para los tipos de contribución. Puede anular los tipos documentados.
linkToUsage Adds a footer with link to usage (either true or false) Default: true
skipCi Hace que el CI ignore la confirmación. (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": []
}

Moving the All Contributors table into a different file

Sección titulada «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. En su lugar, puede usar un archivo diferente para hacerlo.

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.

  1. Install the bot. See the Installation page for instructions.

  2. Add your first contributor. See the Bot Usage page for instructions.

  3. Create the CONTRIBUTORS.md file.

  4. Copy the code which can be found in this guide.

  5. Modify the files key in the .all-contributorsrc JSON file to match your new file name.

    .all-contributorsrc
    {
    "files": [
    "CONTRIBUTORS.md"
    ],
    ...
    }
  6. Now you should be good to go. New contributors will be added to this new file instead of the README.md file.