Konfiguracja Bota

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

Klucze do określenia:

Opcja	Opis	Przykład/Domyślnie
`projectName`	Obowiązkowe, nazwa projektu.	Example: `all-contributors-cli`
`projectOwner`	Obowiązkowe, nazwa użytkownika przez którego projekt jest hostowany.	Example: `tenshiAMD`
`repoType`	Typ repozytorium. Must be either `github` or `gitlab`.	Default: `github`
`repoHost`	Wskazuje nazwę hosta repozytorium. Zmień jeśli używasz repozytorium hostowanego przez siebie.	Default: `https://github.com` if `repoType` is `github`, and `https://gitlab.com` if `repoType` is `gitlab`
`files`	Tablica plików do aktualizacji.	Default: `['README.md']`
`rozmiar obrazu`	Wymiary avatara użytkownika (w pikselach).	Default: `100`
`commit`	Automatyczne przyznawanie odznaki kontrybutora po ich dodaniu.	Default: `false`
`commitConvention`	Commit convention (`angular`, `atom`, or `none`).	Default: `angular`
`contributorsPerLine`	Maksymalna liczba kolumn w tabeli kontrybutorów.	Default: `7`
`contributorsSortAlphabetically`	`true`: Sort alphabetically. `false`: Display in order of addition.	Default: `false`
`badgeTemplate`	Zdefiniuj szablon lodasha do wygenerowania odznaki.
`contributorTemplate`	Zdefiniuj szablon lodasha do wygenerowania kontrybutora.
`wrapperTemplate`	Zdefiniuj swój własny szablon “lodash”, aby załączyć listę współtwórców
`types`	Określ niestandardowe symbole lub podlinkuj szablony dla typów kontrybucji. Możesz nadpisać udokumentowane typy.
`linkToUsage`	Adds a footer with link to usage (either `true` or `false`)	Default: `true`
`skipCi`	Sprawia, że CI ignoruje zatwierdzenie. (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,
  "contributors": []
}

Przenoszenie tabeli wszystkich współtwórców do innego pliku

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. Zamiennie możesz użyć odrębnego pliku.

Oto kroki, które mogą pomóc w osiągnięciu tego celu. For the sake of this tutorial, the different file that we’ll use is going to be named CONTRIBUTORS.md.

Instalacja Bota. See the Installation page for instructions.
Dodaj swojego pierwszego współautora. See the Bot Usage page for instructions.
Create the CONTRIBUTORS.md file.
Copy the code which can be found in this guide.
Modify the files key in the .all-contributorsrc JSON file to match your new file name.
.all-contributorsrc
```
{
    "files": [
        "CONTRIBUTORS.md"
    ],
    ...
}
```
Teraz wszystko powinno być gotowe. New contributors will be added to this new file instead of the README.md file.