Konfiguracja CLI · All Contributors

Konfigurację bota all-contributors możesz przeprowadzić poprzez aktualizację pliku JSON .all-contributorsrc. Przechowywane tam będą dane użyte do stworzenia listy kontrybutorów oraz twoja konfiguracja według której @all-contributors wygeneruje listę.

Przeglądasz Konfigurację CLI. Szukasz Konfiguracji Bota?

Klucze do określenia:

Opcja	Opis	Przykład/Domyślnie
`projectName`	Obowiązkowe, nazwa projektu.	Przykład: `all-contributors-cli`
`projectOwner`	Obowiązkowe, nazwa użytkownika przez którego projekt jest hostowany.	Przykład: `jfmengels`
`repoType`	Typ repozytorium. Musi to być jedno z dwóch: `github` lub `gitlab`.	Domyślnie: `github`
`repoHost`	Wskazuje nazwę hosta repozytorium. Zmień jeśli używasz repozytorium hostowanego przez siebie.	Domyślnie: `https://github.com` jeśli `repoType` to `github` oraz `https://gitlab.com` jeśli `repoType` to `gitlab`
`pliki`	Tablica plików do aktualizacji.	Domyślnie: `['README.md']`
`rozmiar obrazu`	Wymiary avatara użytkownika (w pikselach).	Domyślnie: `100`
`commit`	Automatyczne przyznawanie odznaki kontrybutora po ich dodaniu.	`true` lub `false`
`commitConvention`	Commit convention (`angular`, `atom`, `ember`, `eslint`, `jshint` or `gitmoji`).	Domyślnie: `100`
`contributorsPerLine`	Maksymalna liczba kolumn w tabeli kontrybutorów.	Domyślnie: `7`
`contributorsSortAlphabetically`	`true`: Sortuj alfabetycznie. `false`: Wyświetlaj w kolejności dodania.	Domyślnie: `false`
`badgeTemplate`	Zdefiniuj szablon lodasha do wygenerowania odznaki.
`contributorTemplate`	Zdefiniuj szablon lodasha do wygenerowania kontrybutora.
`types`	Określ niestandardowe symbole lub podlinkuj szablony dla typów kontrybucji. Możesz nadpisać udokumentowane typy.
`contributors`	Lista kontrybutorów projektu, uzupełniana przez 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": []
}