add contributors

add contributors

기타 소스코드

v0.2.2

다운로드

추가 기여자

Markdown 파일 (예 : readme.md)에 기고자를 추가하여 일정에 따라 또는 이벤트에 의해 트리거되는 github 조치

구체적으로 도달 할 수없는 중국 상황 (着重解决了中文内容乱码的问题)을 처리합니다.

풀 요청이나 문제를 자유롭게 제출하십시오. 그러나 템플릿을 따르십시오.

이 프로젝트를 함께 개선하기위한 기고자들을 환영합니다!

용법

.github/workflows/contributors.yml 과 같은 워크 플로 파일을 만듭니다 (이 repo에서 찾을 수 있음).

 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`	아니요	정사각형
무시하십시오	Comma에 의해 분리 된 기고자를 무시했습니다	아니요	`''`

참고 : CONTRIBUTOR 라인 뒤에 처음으로 빈 줄을 남겨 두어야합니다.
참고 : Github는 Markdown 파일 렌더링에서 이미지 스타일을 지원하지 않는 것 같습니다.
참고 : IGNORED_CONTRIBUTORS 사용자 이름이 아닌 디스플레이 이름을 사용합니다
참고 : PULL_REQUEST BRANCH 와 함께 사용해야합니다. 풀 요청을 열 려면 둘 다 제공해야합니다.

관리자

@bobankh

기여하는 방법

우리의 행동 강령을 따라야합니다.

기고 규칙에 대한 기고 지침을 참조하십시오.

코드를 제출하기 전에 모든 테스트를 통과하십시오. 루트 디렉토리에서 pytest -ra 수행하여 모든 테스트를 실행할 수 있습니다.

로컬 컴퓨터에서 Develope에서 로컬 모드를 사용할 수 있습니다. 다음은 명령 줄 도움말 정보입니다.

 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