All Contributors

All Contributors

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

›CLI

Spezifikation

  • Überblick
  • Spezifikation
  • Emoji Key ✨
  • Repository Betreuer
  • Werkzeuge

@all-contributors Bot 🤖

  • Überblick
  • Installation
  • Nutzung
  • Konfiguration
  • FAQs

CLI

  • Überblick
  • Installation
  • Nutzung
  • Konfiguration

Projekt

  • Hilf uns, uns zu verbessern
  • Verhaltenskodex
  • Wer benutzt es?
Edit

CLI Konfiguration

Du kannst das Verhalten des all-contributors Bots konfigurieren, indem du die JSON Datei .all-contributorsrc bearbeitest. Hierin werden die Daten, welche für die Erstellung der Liste der Mitwirkenden benötigt werden, festgelegt. Weiters kann man einstellen wie man von @all-contributors-cli die Liste erstellen lassen möchte.

Du schaust dir die CLI Konfiguration an, welche ähnlich mit der Bot Konfiguration ist?

Dies sind die Schlüssel, die Du angeben kannst:

OptionBeschreibungBeispiel/Standard Wert
projectNameName des Projekt (erforderlich)Beispiel: all-contributors-cli
projectOwnerDer Name des Users der das Projekt hostet ist erforderlich.Beispiel: jfmengels
repoTypeTyp des Repositories. Es muss entweder github oder gitlab sein.Standardwert: github
repoHostVerweist auf den Repository-Hostnamen. Ändere es, wenn Du ein selbst gehostetes Repository verwendest.Standard: https://github.com wenn repoType githubist und https://gitlab.com wenn repoType gitlab ist
filesListe von Dateien die aktualisiert werden sollen.Standardwert: ['README.md']
imageSizeGröße (in px) des User Avatar.Standardwert: 100
commitSoll der Badge automatisch aktualisiert werden, wenn neue Mitwirkende hinzugefügt werden.true oder false
commitConventionCommit-Konvention (angular, atom, ember, eslint, jshint oder gitmoji).Standardwert: none
contributorsPerLineMaximale Anzahl von Spalten für die Tabelle der Mitwirkenden.Standardwert: 7
contributorsSortAlphabeticallytrue: Alphabetisch sortieren. false: In Reihenfolge der Beiträge.Default: false
badgeTemplateDefiniere Deine eigene lodash Vorlage um den Batch erstellen zu lassen.
contributorTemplateDefiniere Deine eigene lodash Vorlage um die Mitwirkenden auf der Liste erstellen zu lassen.
typesDefiniere benutzerdefinierte Symbole oder verknüpfe Beitragstypen Vorlagen. Kann die dokumentierten Typen überschreiben.
contributorsListe der Mitwirkenden für dieses Projekt, diese wird von @all-contributors aktualisiert
{
  "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": []
}
← NutzungHilf uns, uns zu verbessern →
All Contributors