봇 설정
.all-contributorsrc JSON 파일을 업데이트하여 all-contributors bot 동작을 구성 할 수 있습니다.
기여자 목록 생성에 사용된 데이터가 여기에 저장되며, @all-contributors가 목록을 생성하는 방식을 설정할 수 있습니다.
You are viewing the 🤖Bot Configuration, which is similar to the CLI Configuration
지정할 수있는 키는 다음과 같습니다.
| 옵션 | 내용 | 예제/기본값 |
|---|---|---|
프로젝트명 |
필수 옵션인 프로젝트 이름. | 예: all-contributors-cli |
프로젝트 소유자 |
필수적 옵션인 프로젝트가 호스팅되는 사용자의 이름. | 예: tenshiAMD |
repoType |
리포지토리 유형. github이거나 gitlab이어야 함. |
기본 값: github |
repoHost |
리포지토리 호스트를 가리킵니다. 자가 호스팅 리포지토리를 사용하는 경우 변경하십시오. | 기본 값: repoType이 github이면 https://github.com, gitlab이면 https://gitlab.com |
files |
업데이트 할 파일의 배열. | 기본 값: ['README.md'] |
imageSize |
사용자의 아바타 크기 (픽셀 단위) 입니다. | 기본 값: 100 |
commit |
기여자를 자동 추가 할 때 자동 커밋 배지. | 기본 값: false |
commitConvention |
Commit convention (angular, atom, or none). |
기본 값: angular |
commitType |
선택한 commitConvention에 따라 commit의 type을 설정하세요 (Conventional Commits specification에서 자세히 확인할 수 있습니다. |
기본 값: docs |
contributorsPerLine |
Contributors 테이블의 최대 열 수. | 기본 값: 7 |
contributorsSortAlphabetically |
true: 알파벳 순으로 정렬. false: 추가된 순서대로 표시. |
기본 값: false |
badgeTemplate |
Lodash 템플릿을 정의하여 배지를 생성하세요. | |
contributorTemplate |
Lodash 템플릿을 정의하여 기여자를 생성하세요. | |
wrapperTemplate |
Lodash 템플릿을 정의하여 기여자 목록 줄바꿈을 설정하세요. | |
types |
기여 유형에 대한 사용자 기호 또는 링크 템플리트를 지정하세요. 문서화 된 유형을 대체 할 수 있습니다. | |
linkToUsage |
사용 여부를 나타내는 링크가 포함된 footer를 추가합니다(true 또는 false 중 하나) |
기본 값: true |
skipCi |
CI가 이 커밋을 무시하도록 합니다. (true 또는 false 중 하나) |
기본 값: true |
contributors |
List of contributors for this project, this is updated by @all-contributors add |
{ "projectName": "all-contributors", "projectOwner": "all-contributors", "repoType": "github", "repoHost": "https://github.com", "files": ["README.md"], "imageSize": 100, "commit": false, "contributorsPerLine": 7, "contributorsSortAlphabetically": false, "badgeTemplate": "[](#contributors)", "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>", "wrapperTemplate": "\n<table>\n <tbody><%= bodyContent %> </tbody>\n<%= tableFooterContent %></table>\n\n", "types": { "custom": { "symbol": "🔭", "description": "A custom contribution type.", "link": "[<%= symbol %>](<%= url %> \"<%= description %>\")," } }, "linkToUsage": true, "skipCi": true, "commitType": "docs" "contributors": []}All Contributors 테이블을 다른 파일로 옮기기
섹션 제목: “All Contributors 테이블을 다른 파일로 옮기기”As you know, the default file for the contributors table is README.md. But if your project has tons of contributors, it doesn’t make sense to include the All Contributors table in the README.md file. 그런 상황에는 다른 파일에 기여자를 입력할 수 있습니다.
많은 기여자가 있을 때에는 다음과 같이 구조를 바꾸어 보세요. For the sake of this tutorial, the different file that we’ll use is going to be named CONTRIBUTORS.md.
-
먼저 봇을 설치하세요. See the Installation page for instructions.
-
첫 번째 기여자를 추가합니다. See the Bot Usage page for instructions.
-
Create the
CONTRIBUTORS.mdfile. -
Copy the code which can be found in this guide.
-
Modify the
fileskey in the.all-contributorsrcJSON file to match your new file name..all-contributorsrc {"files": ["CONTRIBUTORS.md"],...} -
이제 준비가 되었습니다. New contributors will be added to this new file instead of the
README.mdfile.
