add contributors

Tambah Kontributor

Tindakan GitHub untuk menambahkan kontributor ke file penurunan harga Anda (yaitu readme.md) secara otomatis sesuai jadwal atau dipicu oleh acara

Secara khusus menangani konteks Cina yang tidak terjangkau (着重解决了中文内容乱码的问题)

Jangan ragu untuk mengirimkan permintaan tarik atau masalah, tetapi pastikan untuk mengikuti templat

Selamat datang kontributor untuk meningkatkan proyek ini bersama -sama!

Penggunaan

Buat file alur kerja seperti .github/workflows/contributors.yml (Anda dapat menemukannya di repo ini)

 name : Add contributors
on :
  schedule :
    - cron :  ' 20 20 * * * '
# push:
#   branches:
#     - master

jobs :
  add-contributors :
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@v2
    - uses : BobAnkh/add-contributors@master
      with :
        CONTRIBUTOR : ' ### Contributors '
        COLUMN_PER_ROW : ' 6 '
        ACCESS_TOKEN : ${{secrets.GITHUB_TOKEN}}
        IMG_WIDTH : ' 100 '
        FONT_SIZE : ' 14 '
        PATH : ' /README.md '
        COMMIT_MESSAGE : ' docs(README): update contributors '
        AVATAR_SHAPE : ' round '

Parameter

Parameter	Keterangan	Diperlukan	Bawaan
Repo_name	Nama Repositori	TIDAK	'' Yang berarti repositori saat ini
PENYUMBANG	Di mana Anda ingin menambahkan daftar kontributor	TIDAK	### Contributors
Kolom_per_row	Jumlah kontributor per baris	TIDAK	6
Access_token	Token Akses GitHub	Ya	Anda bisa melewati ${{secrets.GITHUB_TOKEN}}
Img_width	Lebar img	TIDAK	100
Font_size	Ukuran nama font (PX)	TIDAK	14
JALUR	Jalur ke file yang ingin Anda tambahkan daftar kontributor	TIDAK	/README.md
CABANG	Cabang untuk memperbarui file yang ditentukan dalam path	TIDAK	'' yang berarti cabang default
Pull_request	Buka permintaan tarik baru jika diatur ke nama cabang target	TIDAK	'' yang berarti tidak membuka permintaan tarik secara default
Commit_message	melakukan pesan	TIDAK	docs(README): update contributors
Avatar_shape	round untuk avatar bulat dan square untuk avatar persegi	TIDAK	persegi
Diabaikan_contributors	Kontributor yang diabaikan, dipisahkan oleh koma	TIDAK	''

Catatan: Anda harus meninggalkan garis kosong setelah garis CONTRIBUTOR untuk pertama kalinya

Catatan: GitHub tampaknya belum mendukung gaya gambar dalam rendering file markdown

CATATAN: IGNORED_CONTRIBUTORS mengambil nama tampilan bukan nama pengguna

Catatan: PULL_REQUEST harus digunakan dengan BRANCH bersama, keduanya harus disediakan jika Anda ingin membuka permintaan tarik

Pemeliharaan

@Bobankh

Bagaimana berkontribusi

Anda harus mengikuti kode perilaku kami.

Lihat Pedoman yang Berkontribusi untuk Konvensi yang Berkontribusi.

Pastikan untuk lulus semua tes sebelum mengirimkan kode Anda. Anda dapat melakukan pytest -ra di direktori root untuk menjalankan semua tes.

Anda dapat menggunakan mode lokal saat mengembangkannya di mesin lokal Anda, berikut adalah info bantuan baris perintah:

 usage: main.py [-h] [-m MODE] [-f FILE] [-o OUTPUT] [-t TOKEN]

optional arguments:
  -h, --help            show this help message and exit
  -m MODE, --mode MODE  choose to use local-dev mode or on github action mode.
                        Valid values are 'local' or 'github'
  -f FILE, --file FILE  configuration file to read from when running local-dev
                        mode
  -o OUTPUT, --output OUTPUT
                        output file when running local-dev mode
  -t TOKEN, --token TOKEN
                        Github Access Token

Kontributor

Yixin Shen

Bailey Harrington

Casper

LISENSI

Apache-2.0 © Bobankh