Konfiguracja Bota · 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ę Bota, która podobna jest do Konfiguracji CLI

Klucze do określenia:

Opcja	Opis	Przykład/Domyślnie
`pliki`	Tablica plików do aktualizacji.	Domyślnie: `['README.md']`
`rozmiar obrazu`	Wymiary avatara użytkownika (w pikselach).	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.
`skipCi`	Sprawia, że CI ignoruje zatwierdzenie. (either `true` or `false`)	Domyślnie: `true`
`contributors`	Lista Contributors do tego projektu została zaktualizowana poprzez komendę @all-contributors add

{
  "files": ["README.md"],
  "imageSize": 100,
  "contributorsPerLine": 7,
  "contributorsSortAlphabetically": false,
  "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 %>\"),"
    }
  },
  "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.

Install the bot. See the Installation page for instructions.
Add your first contributor. See the Bot Usage page for instructions.
Create the CONTRIBUTORS.md file.

Copy the code from the Contributors section in the README.md file, starting at the ALL-CONTRIBUTORS-LIST:START line, and ending at the ALL-CONTRIBUTORS-LIST:END line.

Example:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
  <td align="center">...</td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Modify the files key in the .all-contributorsrc JSON file to match your new file name.
```
{
"files": [
  "CONTRIBUTORS.md"
],
...
}
```
Now you should be good to go. New contributors will be added to this new file instead of the README.md file.