add contributors

Дополнительные контролирующие

Действие GitHub, чтобы автоматически добавить вкладчиков к вашему файлу Markdown (IE 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 токен	да	Вы можете просто передать ${{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 в первый раз

Примечание: 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

Участники

Йисин Шен

Бейли Харрингтон

Каспер

ЛИЦЕНЗИЯ

Apache-2.0 © Bobankh