콘텐츠로 이동

봇 설정

You can configure the all-contributors bot behaviour by updating the .all-contributorsrc JSON file. The data used to generate the contributors list will be stored there, and you can configure how you want @all-contributors to generate the list.

You are viewing the 🤖Bot Configuration, which is similar to the CLI Configuration

지정할 수있는 키는 다음과 같습니다.

옵션내용예제/기본값
프로젝트명필수 옵션인 프로젝트 이름.Example: all-contributors-cli
프로젝트 소유자필수적 옵션인 프로젝트가 호스팅되는 사용자의 이름.Example: tenshiAMD
repoType리포지토리 유형. Must be either github or gitlab.Default: github
repoHost리포지토리 호스트를 가리킵니다. 자가 호스팅 리포지토리를 사용하는 경우 변경하십시오.Default: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab
files업데이트 할 파일의 배열.Default: ['README.md']
imageSize사용자의 아바타 크기 (픽셀 단위) 입니다.Default: 100
commit기여자를 자동 추가 할 때 자동 커밋 배지.Default: false
commitConventionCommit convention (angular, atom, or none).Default: angular
contributorsPerLineContributors 테이블의 최대 열 수.Default: 7
contributorsSortAlphabeticallytrue: Sort alphabetically. false: Display in order of addition.Default: false
badgeTemplateLodash 템플릿을 정의하여 배지를 생성하세요.
contributorTemplateLodash 템플릿을 정의하여 기여자를 생성하세요.
wrapperTemplateLodash 템플릿을 정의하여 기여자 목록 줄바꿈을 설정하세요.
types기여 유형에 대한 사용자 기호 또는 링크 템플리트를 지정하세요. 문서화 된 유형을 대체 할 수 있습니다.
linkToUsageAdds a footer with link to usage (either true or false)Default: true
skipCiCI가 이 커밋을 무시하도록 합니다. (either true or false)Default: true
contributorsList 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": "[![All Contributors](https://img.shields.io/github/all-contributors/<%= projectOwner %>/<%= projectName %>?color=ee8449&style=flat-square)](#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,
"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.

  1. 먼저 봇을 설치하세요. See the Installation page for instructions.

  2. 첫 번째 기여자를 추가합니다. See the Bot Usage page for instructions.

  3. Create the CONTRIBUTORS.md file.

  4. Copy the code which can be found in this guide.

  5. Modify the files key in the .all-contributorsrc JSON file to match your new file name.

    .all-contributorsrc
    {
    "files": [
    "CONTRIBUTORS.md"
    ],
    ...
    }
  6. 이제 준비가 되었습니다. New contributors will be added to this new file instead of the README.md file.