All Contributors

All Contributors

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

›CLI

Specyfikacja

  • Przegląd
  • Specyfikacja
  • Znacznik Emoji ✨
  • Repository Maintainers
  • Tooling

@bot All Contributors 🤖

  • Przegląd
  • Instalacja
  • Korzystanie
  • Konfiguracja
  • FAQs

CLI

  • Przegląd
  • Instalacja
  • Korzystanie
  • Konfiguracja

Projekt

  • Help us Improve
  • Kodeks Postępowania
  • Kto tego używa?
Edit

Konfiguracja CLI

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:

OpcjaOpisPrzykład/Domyślnie
projectNameObowiązkowe, nazwa projektu.Przykład: all-contributors-cli
projectOwnerObowiązkowe, nazwa użytkownika przez którego projekt jest hostowany.Przykład: jfmengels
repoTypeTyp repozytorium. Musi to być jedno z dwóch: github lub gitlab.Domyślnie: github
repoHostWskazuje 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
plikiTablica plików do aktualizacji.Domyślnie: ['README.md']
rozmiar obrazuWymiary avatara użytkownika (w pikselach).Domyślnie: 100
commitAutomatyczne przyznawanie odznaki kontrybutora po ich dodaniu.true lub false
commitConventionCommit convention (angular, atom, ember, eslint, jshint or gitmoji).Domyślnie: 100
contributorsPerLineMaksymalna liczba kolumn w tabeli kontrybutorów.Domyślnie: 7
contributorsSortAlphabeticallytrue: Sortuj alfabetycznie. false: Wyświetlaj w kolejności dodania.Domyślnie: false
badgeTemplateZdefiniuj szablon lodasha do wygenerowania odznaki.
contributorTemplateZdefiniuj szablon lodasha do wygenerowania kontrybutora.
typesOkreśl niestandardowe symbole lub podlinkuj szablony dla typów kontrybucji. Możesz nadpisać udokumentowane typy.
contributorsLista 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": []
}
← KorzystanieHelp us Improve →
All Contributors