All Contributors

All Contributors

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

›Interfaz de Línea de Comandos

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 de la interfaz de línea de comandos

Puede configurar all-contributors actualizando el archivo JSON .all-contributorsrc. Los datos utilizados para generar la lista de colaboradores se almacenarán allí, y puede configurar cómo desea que all-contributors-cli genere la lista.

Está viendo la configuración de CLI, ¿está buscando la configuración del bot?

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.Ejemplo: jfmengels
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.true o false
commitConventionConvención de commit (angular, atom, ember, eslint, jshint o gitmoji).Por defecto: none
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.
typesEspecifique símbolos personalizados o plantillas de enlaces para los tipos de contribución. Puede anular los tipos documentados.
contributorsLista de colaboradores para este proyecto, esto se actualiza por all-contributors add
{
  "projectName": "all-contributors-cli",
  "projectOwner": "jfmengels",
  "repoType": "github",
  "repoHost": "https://github.com",
  "files": ["README.md"],
  "imageSize": 100,
  "commit": false,
  "contributorsPerLine": 7,
  "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 %>\"),"
    }
  },
  "contributors": []
}
← UtilizaciónAyúdenos a mejorar →
All ContributorsStar All Contributors