All Contributors

All Contributors

  • Documentación
  • GitHub
  • Languages iconEspañol
    • English
    • 日本語
    • Deutsch
    • Français
    • Bahasa Indonesia
    • 한국어
    • Polski
    • Português (Brasil)
    • Русский
    • 中文

›@all-contributors bot 🤖

Especificación

  • Reseña
  • Especificación
  • ✨ Emoji clave
  • Mantenedores de repositorio
  • Herramientas

@all-contributors bot 🤖

  • Reseña
  • Instalación
  • Utilización
  • Configuración
  • FAQs

Interfaz de Línea de Comandos

  • Reseña
  • Instalación
  • Utilización
  • Configuración

Proyecto

  • Ayúdenos a mejorar
  • Código de conducta
  • ¿Quién lo usa?
Edit

Configuración del bot

Puede configurar El bot all-contribuitors actualizando el archivo JSON .all-contributorsrc Archivo JSON. 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.

Usted está viendo la bot configuración 🤖, que es similar a la de configuración CLI

Estas son las claves que puede especificar:

OpciónDescriciónEjemplo/Defecto
projectNameObligatorio, nombre del proyecto.Ejemplo: all-contributors-cli
projectOwnerObligatorio, nombre del usuario que aloja el proyecto.Example: tenshiAMD
repoTypeTipo de repositorio. Debe ser github o gitlab.Defecto: 100
repoHostApunta al nombre de host del repositorio. Cámbiala si usas un repositorio auto alojado.Defecto: https://github.com si repoType es github, y https://gitlab.com si repoType es gitlab
filesArreglo (o vector) de archivos para actualizar.Defecto: ['README.md']
imageSizeTamaño (en px) del avatar del usuario.Defecto: 100
commitInsignia de auto-commit al agregar colaboradores.Por defecto: false
commitConventionCommit convention (angular, atom, ember, eslint, jshint, gitmoji, or none).Default: angular
contributorsPerLineNúmero máximo de columnas para la tabla de colaboradores.Defecto: 7
contributorsSortAlphabeticallytrue: Ordena alfabéticamente. false: Mostar por orden de contribución.Por defecto: false
badgeTemplateDefina su propia plantilla de lodash para generar la insignia.
contributorTemplateDefina su propia plantilla de lodash para generar el colaborador.
wrapperTemplateDefine your own lodash template to wrap the list of contributors
typesEspecifique símbolos personalizados o plantillas de enlaces para los tipos de contribución. Puede anular los tipos documentados.
linkToUsageAdds a footer with link to usage (either true or false)Default: true
skipCiMakes the CI ignore the commit. (either true or false)Default: true
contributorsLista de los colaboradores de este proyecto, este se actualiza por @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,
  "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.

  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.

    {
    "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.

← UtilizaciónFAQs →
All Contributors