add contributors下載 - add contributors源代碼下載

add contributors

其他源碼

v0.2.2

下載

添加劑

gitHub操作將貢獻者添加到您的降價文件（即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訪問令牌	是的	您只需通過`${{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`的圓形頭像	不	正方形
忽略的_contributor	忽略了貢獻者，被逗號分開	不	`''`

注意：您應該首次在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