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