Edit

Pemasangan CLI

1. Instal CLI

Versi NPM AUR Version

Modul ini didistribusikan melalui npm yang dibundel dengan node dan harus dipasang sebagai salah satu devDependencies proyek kamu:

yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli

Alternatively, Arch Linux users can install the all-contributors-cli package from the AUR.

The CLI is node based, if you don't wish to add a node dependency use the @all-contributors bot 🤖

2. Inisialisasi Proyek

Inisialisasi proyeknya menggunakan init dan jawab beberapa pertanyaan

yarn all-contributors init # or npx all-contributors init 

# Or directly execute the bin
./node_modules/.bin/all-contributors init

3. Tambah beberapa kontributor

yarn all-contributors add jfmengels doc
yarn all-contributors generate

Untuk lebih lanjut tentang perintah, lihat penggunaan CLI

4. Perbarui dokumentasi Berkontribusi kamu

Pertimbangkan untuk memperbarui CONTRIBUTING.md kamu atau yang serupa dengan langkah-langkah tentang bagaimana kontributor kamu dapat menambahkan diri mereka sendiri. Kamu bahkan dapat menautkan ke dokumentasi penggunaan cli.

5. Opsional tambah skrip shortcut ke package.json kamu

Secara opsional kamu dapat menambah shortcut untuk perintahmu di package.json kolom scripts.

Sebagai contoh:

{
  "scripts": {
    "contributors:tambah": "all-contributors add",
    "contributors:bikin": "all-contributors generate"
  }
}

Agar shortcutnya bisa menjadi

yarn contributors:tambah jfmengels doc

Apa selanjutnya

← IkhtisarPenggunaan →