Edit

Penggunaan CLI

Dokumentasi penggunaan ini mengasumsikan kamu sudah mengikuti langkah-langkah instalasi cli.

Catatan singkat: Dibawah ini kami akan menunjukan all-contributors untuk menjaga hal-hal menjadi sederhana, tapi jika kamu mengalami kesulitan, rute yarn all-contributors layak untuk dicoba 😺

Perintah

all-contributors init

Jalankan ini ketika kamu pertama kali mulai menggunakan all-contributors-cli. Perintah ini meminta beberapa pertanyaan dan membangun proyek untuk all-contributors. Konfigurasi ini termasuk membuat berkas konfigurasi .all-contributorsrc dan membuat tabel kontributor di files yang kamu tentukan (biasanya di README.md).

all-contributors add

Gunakan add untuk menambah kontributor baru di proyek kamu, atau tambahkan cara baru di mana mereka berkontribusi. Mereka akan ditambahkan ke file konfigurasi kamu, dan file kontributor akan diperbarui sama seperti jika kamu menggunakan perintah generate.

# Menambah kontributor baru <username>, yang membuat kontribusi berjenis <kontribusi>
all-contributors add <username> <kontribusi>
# Contoh:
all-contributors add jfmengels code,doc

Dimana username adalah username pengguna GitHub atau Gitlab, dan kontribusi adalah daftar kontribusi yang dipisah dengan ,. Lihat Kunci Emoji (Referensi Jenis Kontribusi) untuk daftar jenis kontribusi yang valid.

Pengguna GitLab: Lihat persyaratan tambahan untuk pengguna GitLab

all-contributors check

Gunakan check untuk membandingkan kontributor dari GitHub dengan yang dikreditkan di dalam file .all-contributorsrc, untuk memastikan bahwa kredit diberikan di tempatnya.

Karena pembatasan API GitHub, perintah ini hanya berfungsi untuk proyek dengan kontribusi kurang dari 500 (Kecuali jika kamu menetapkan PRIVATE_TOKEN seperti yang disebutkan di pengguna GitHub).

all-contributors generate

Gunakan generate untuk membaca daftar kontributor dari file .all-contributorsrc kamu dan memperbarui tabel kontributor yang ditentukan oleh kunci files.

Harap dicatat bahwa perintah harus dapat menemukan tag berikut di file-file itu, untuk memperbarui tabel:

<!-- ALL-CONTRIBUTORS-LIST:START - Jangan hapus atau ubah bagian ini -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Also note that it needs to find the following tags in order to update the badge:

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Pengguna GitHub

Dalam beberapa kasus, kamu mungkin melihat pesan kesalahan GitHub API rate limit exceeded for xxx. Kamu mungkin perlu menetapkan variabel environment bernama PRIVATE_TOKEN untuk menghindari batas tingkat GitHub ini.

Token privat adalah akses token personal untuk autentikasi dengan API GitHub.

Pengguna Gitlab

Harap dicatat bahwa jika kamu menggunakan instansi gitlab yang dihosting sendiri, beberapa perintah akan mengharuskan kamu menetapkan variabel environment bernama PRIVATE_TOKEN.

Token privat adalah akses token personal untuk autentikasi dengan API GitLab.

# set private token on Linux
export PRIVATE_TOKEN=your_private_token
# set private token on Windows
set PRIVATE_TOKEN=your_private_token

Apa selanjutnya

← PemasanganKonfigurasi →