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

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

Berikut adalah kunci yang bisa kamu tentukan:

PilihanDeskripsiContoh/Bawaan
projectNameNama proyek, harus diisi.Contoh: all-contributors-cli
projectOwnerNama pengguna yang memiliki proyek tsb, harus diisi.Example: tenshiAMD
repoTypeTipe repositori. Harus github atau gitlab.Bawaan: github
repoHostMengarah ke nama host repositori. Ganti jika kamu menggunakan repositori yang di-hosting sendiri.Bawaan: https://github.com jika repoType adalah github, dan https://gitlab.com jika repoType adalah gitlab
filesArray file untuk diperbarui.Bawaan: ['README.md']
imageSizeUkuran (dalam px) dari avatar pengguna.Bawaan: 100
commitLencana auto-commit ketika menambahkan kontribusi.Utama: salah
melakukan KonvensiCommit convention (angular, atom, ember, eslint, jshint, gitmoji, or none).Default: angular
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.
wrapperTemplateDefine your own lodash template to wrap the list of contributors
typesTentukan simbol atau templat tautan khusus untuk jenis kontribusi. Dapat mengganti jenis yang didokumentasikan.
linkToUsageAdds a footer with link to usage (either true or false)Default: true
skipCiMakes the CI ignore the commit. (either true or false)Default: true
contributorsDaftar kontributor untuk proyek ini, diperbarui oleh @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": []
}

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 which can be found in this guide.

  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