add contributorsダウンロードadd contributorsソースコードのダウンロードを追加します

add contributors

その他のソースコード

v0.2.2

ダウンロード

コントリビュータ師を追加します

マークダウンファイル（つまりreadme.md）に貢献者をスケジュールまたはトリガーして自動的に追加するためのgithubアクション

特に到達不可能な中国の文脈（着重解决了中文内容乱码的问题）を処理する

プルリクエストまたは問題をお気軽に送信してくださいが、必ずテンプレートに従ってください

このプロジェクトを一緒に改善するための貢献者を歓迎します！

使用法

.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	ラウンドアバターとスクエアアバターの`square`に`round`を設定します	いいえ	四角
Ingrored_Contributors	カンマによって分離された無視された貢献者	いいえ	`''`

注： CONTRIBUTORラインの後に初めて空白を残す必要があります
注：githubはまだマークダウンファイルレンダリングで画像スタイルをサポートしていないようです
注： 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