good first issues

Masalah pertama yang bagus

Temukan masalah pertama yang bagus langsung dari CLI Anda!

Pasang masalah pertama yang bagus

Membutuhkan Python 3.6.1 atau lebih tinggi.

$ pip3 install good-first-issues --upgrade

CLI menggunakan alias gfi untuk menjalankan perintah.

Isi

• Pasang masalah pertama yang bagus
• Isi
  • Buat Token Akses Pribadi Gitub
• Penggunaan
  • Cari masalah
    • Permintaan semua repo di suatu organisasi
    • Menanyakan satu repo dalam suatu organisasi
    • Permintaan semua repo di profil pengguna
    • Permintaan satu repo di profil pengguna.
  • Cari masalah yang disetujui Hacktoberfest
    • Permintaan semua repo dengan topik hacktoberfest
    • Permintaan semua repo dengan topik 'hacktoberfest' di organisasi atau di profil pengguna
  • Mengubah batas output
  • Melihat masalah di browser
• Berkontribusi

Buat Token Akses Pribadi Gitub

CLI memerlukan token akses pribadi GitHub untuk membuat permintaan ke Github API.

Dapatkan token akses pribadi GitHub berbutir halus

Anda dapat menambahkan deskripsi ke token Anda, pilih "Repositori Publik (hanya baca)" dan pilih Generate Token .

Berikan token untuk cli:

$ gfi config

Token disimpan secara lokal di /home/<username>/.gfi/good-first-issues <username>/.gfi/good-first-issues file.

Token dalam variabel lingkungan:

Simpan token dengan nama GFITOKEN di lingkungan Anda.

Penggunaan

GitHub menyediakan API untuk mengambil data pengguna dan organisasi. Token akses pribadi diperlukan untuk otentikasi dan pengambilan data.

Cari masalah

Untuk mencari masalah, gunakan perintah gfi search .

Permintaan semua repo di suatu organisasi

$ gfi search " rust-lang "

Demo

Menanyakan satu repo dalam suatu organisasi

$ gfi search " facebook " --repo " jest "

Demo

Permintaan semua repo di profil pengguna

$ gfi search " yankeexe " --user

Demo

Permintaan satu repo di profil pengguna.

-Bendera --user Tidak Diperlukan Di Sini.

$ gfi search " yankeexe " --repo " good-first-issues "

Demo

Cari masalah yang disetujui Hacktoberfest

Permintaan semua repo dengan topik hacktoberfest

$ gfi search --hacktoberfest

$ gfi search -hf

Demo

Permintaan semua repo dengan topik 'hacktoberfest' di organisasi atau di profil pengguna

Permintaan semua repo dengan topik 'hacktoberfest' dalam sebuah organisasi.

$ gfi search " facebook " --hacktoberfest

Demo

Permintaan semua repo dengan topik 'hacktoberfest' di profil pengguna. -Bendera --user Tidak Diperlukan Di Sini.

$ gfi search " yankeexe " --hacktoberfest

Demo

Mengubah batas output

Output terbatas untuk menampilkan 10 masalah secara default. Gunakan -Bendera --limit untuk mengatur jumlah masalah untuk output atau --all tanpa batas.

Batasi masalah menjadi 12

$ gfi search " facebook " --limit 12

Demo

Lihat semua masalah yang ditemukan.

$ gfi search " rust-lang " --all

Melihat masalah di browser

Sulit untuk menavigasi semua masalah ketika Anda memiliki --all bendera diaktifkan, Anda dapat melihat masalah di browser Anda dengan mudah menggunakan bendera --web .

$ gfi search " facebook " --all --web

Demo

Berkontribusi

Untuk panduan tentang pengaturan lingkungan pengembangan dan bagaimana memberikan kontribusi untuk good-first-issues , lihat pedoman yang berkontribusi.