Edit

Bot Konfiguration

Du kannst das Verhalten des all-contributors Bots konfigurieren, indem du die JSON Datei .all-contributorsrc bearbeitest. 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.

Du siehst die 🤖Bot Konfiguration, welche ähnlich mit der CLI 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.Example: tenshiAMD
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.Default: false
commitConventionCommit convention (angular, atom, ember, eslint, jshint, gitmoji, or none).Default: angular
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.
wrapperTemplateDefine your own lodash template to wrap the list of contributors
typesDefiniere benutzerdefinierte Symbole oder verknüpfe Beitragstypen Vorlagen. Kann die dokumentierten Typen überschreiben.
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
contributorsListe der Mitwirkenden für dieses Projekt, diese wird von @all-contributors aktualisiert
 
{
  "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.

← NutzungFAQs →