add contributors ดาวน์โหลด

add contributors

ซอร์สโค้ดอื่น ๆ

v0.2.2

ดาวน์โหลด

ผู้เข้าร่วม

การกระทำของ GitHub เพื่อเพิ่มผู้มีส่วนร่วมในไฟล์ Markdown ของคุณ (เช่น readme.md) โดยอัตโนมัติตามกำหนดเวลาหรือทริกเกอร์โดยเหตุการณ์

จัดการบริบทจีนที่ไม่สามารถเข้าถึงได้โดยเฉพาะ (着重解决了中文内容乱码的问题)

อย่าลังเลที่จะส่งคำขอดึงหรือปัญหา แต่ตรวจสอบให้แน่ใจว่าได้ติดตามเทมเพลต

ยินดีต้อนรับผู้มีส่วนร่วมในการปรับปรุงโครงการนี้ด้วยกัน!

การใช้งาน

สร้างไฟล์เวิร์กโฟลว์เช่น .github/workflows/contributors.yml (คุณสามารถค้นหาได้ใน repo นี้)

 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 '

พารามิเตอร์

พารามิเตอร์	คำอธิบาย	ที่จำเป็น	ค่าเริ่มต้น
repo_name	ชื่อที่เก็บ	เลขที่	`''` ซึ่งหมายถึงที่เก็บปัจจุบัน
ผู้สนับสนุน	ที่ที่คุณต้องการเพิ่มรายชื่อผู้มีส่วนร่วม	เลขที่	`### Contributors`
column_per_row	จำนวนผู้มีส่วนร่วมต่อแถว	เลขที่	`6`
access_token	โทเค็นการเข้าถึง GitHub	ใช่	คุณสามารถผ่าน `${{secrets.GITHUB_TOKEN}}`
img_width	ความกว้างของ IMG	เลขที่	`100`
font_size	ขนาดตัวอักษรของชื่อ (PX)	เลขที่	`14`
เส้นทาง	พา ธ ไปยังไฟล์ที่คุณต้องการเพิ่มรายการผู้มีส่วนร่วม	เลขที่	`/README.md`
สาขา	สาขาเพื่ออัปเดตไฟล์ที่ระบุในพา ธ	เลขที่	`''` ซึ่งหมายถึงสาขาเริ่มต้น
pull_request	เปิดคำขอดึงใหม่หากตั้งค่าเป็นชื่อสาขาเป้าหมาย	เลขที่	`''` ซึ่งหมายความว่าไม่เปิดคำขอดึงตามค่าเริ่มต้น
commit_message	ส่งข้อความ	เลขที่	`docs(README): update contributors`
avatar_shape	ตั้ง `round` สำหรับ Avatar ทรงกลมและ `square` สำหรับ Avatar สี่เหลี่ยมจัตุรัส	เลขที่	สี่เหลี่ยม
ละเว้น _contributors	ผู้มีส่วนร่วมที่ไม่สนใจ	เลขที่	`''`

หมายเหตุ: คุณควรทิ้งสายว่างไว้หลังจากสาย CONTRIBUTOR เป็นครั้งแรก
หมายเหตุ: GitHub ดูเหมือนจะไม่รองรับรูปแบบภาพในการแสดงผลไฟล์ markdown
หมายเหตุ: IGNORED_CONTRIBUTORS ใช้ ชื่อจอแสดงผล ไม่ใช่ ชื่อผู้ใช้
หมายเหตุ: ต้องใช้ PULL_REQUEST กับ BRANCH ร่วมกัน ควรให้ ทั้งสองอย่างหากคุณต้องการ เปิดคำขอดึง

ผู้ดูแล

@bobankh

วิธีการมีส่วนร่วม

คุณควรปฏิบัติตามจรรยาบรรณของเรา

ดูแนวทางที่มีส่วนร่วมสำหรับการประชุมที่มีส่วนร่วม

ตรวจสอบให้แน่ใจว่าได้ผ่านการทดสอบทั้งหมดก่อนส่งรหัสของคุณ คุณสามารถดำเนินการ pytest -ra ที่ไดเรกทอรีรากเพื่อเรียกใช้การทดสอบทั้งหมด

คุณสามารถใช้โหมดท้องถิ่นเมื่อพัฒนามันบนเครื่องในพื้นที่ของคุณนี่คือข้อมูลช่วยเหลือบรรทัดคำสั่ง:

 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