add contributors - add contributors

add contributors

شفرة المصدر الأخرى

v0.2.2

تنزيل

إضافة موزوبين

إجراء github لإضافة مساهمين إلى ملف Markdown (أي readme.md) تلقائيًا في الموعد المحدد أو يتم تشغيله بالأحداث

على وجه التحديد التعامل مع السياق الصيني الذي لا يمكن الوصول إليه (着重解决了中文内容乱码的问题)

لا تتردد في تقديم طلب سحب أو مشكلة ، ولكن تأكد من اتباع القوالب

مرحبًا بكم في تحسين هذا المشروع معًا!

الاستخدام

قم بإنشاء ملف سير العمل مثل .github/workflows/contributors.yml .

 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 Access Token	نعم	يمكنك فقط تمرير `${{secrets.GITHUB_TOKEN}}`
IMG_WIDTH	عرض IMG	لا	`100`
font_size	حجم الخط من الاسم (PX)	لا	`14`
طريق	مسار إلى الملف الذي تريد إضافة قائمة المساهمين	لا	`/README.md`
فرع	الفرع لتحديث الملف المحدد في المسار	لا	`''` وهو ما يعني الفرع الافتراضي
pull_request	افتح طلب سحب جديد إذا تم تعيينه على اسم الفرع المستهدف	لا	`''` ما يعني عدم فتح طلب السحب افتراضيًا
commit_message	رسالة ارتكاب	لا	`docs(README): update contributors`
Avatar_shape	انطلق `round` لجسور مستديرة `square` لتصوير الرمزية المربعة	لا	مربع
تجاهل _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