All Contributors

All Contributors

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

›Bot @all-contributors 🤖

Spesifikasi

  • Ikhtisar
  • Spesifikasi
  • Kunci Emoji ✨
  • Pemelihara Repositori
  • Perkakas

Bot @all-contributors 🤖

  • Ikhtisar
  • Pemasangan
  • Penggunaan
  • Konfigurasi
  • Kumpulan - kumpula pertanyaan yang sering diajukan

CLI

  • Ikhtisar
  • Pemasangan
  • Penggunaan
  • Konfigurasi

Proyek

  • Bantu kami Lebih Maju
  • Kode Etik
  • Siapa saja yang menggunakannya?
Edit

Konfigurasi Bot

Kamu dapat mengonfigurasi perilaku bot all-contributors dengan memperbarui berkas JSON .all-contributorsrc. Data yang digunakan untuk membuat daftar kontributor akan disimpan di sana, dan kamu dapat mengonfigurasi bagaimana kamu ingin @all-contributors untuk membuat daftar.

Kamu sedang melihat 🤖Konfigurasi Bot, yang mirip dengan Konfigurasi CLI

Berikut adalah kunci yang bisa kamu tentukan:

PilihanDeskripsiContoh/Bawaan
filesArray file untuk diperbarui.Bawaan: ['README.md']
imageSizeUkuran (dalam px) dari avatar pengguna.Bawaan: 100
contributorsPerLineMaksimal jumlah kolom untuk tabel kontributor.Bawaan: 7
kontributor Sortir menurut abjadtrue: Sort alphabetically. false: Display in order of addition.Utama: salah
badgeTemplateTentukan template lodash kamu sendiri untuk menghasilkan lencana.
contributorTemplateTentukan template lodash kamu sendiri untuk menghasilkan kontributor.
typesTentukan simbol atau templat tautan khusus untuk jenis kontribusi. Dapat mengganti jenis yang didokumentasikan.
xJalan: / meja / tbadan / tr [8] / td / kodeMembuat CI mengabaikan komit. (antara benar atau salah)Perangkat utama: benar
contributorsDaftar kontributor untuk proyek ini, diperbarui oleh @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.

  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 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 -->
    
  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.

← PenggunaanKumpulan - kumpula pertanyaan yang sering diajukan →
All Contributors