Edit

CLI 설치

1. CLI 도구 설치

NPM 버전 AUR Version

이 모듈은 node와 함께 제공되는 npm을 통해 배포됩니다. 그리고 프로젝트의 devDependencies로 설치되어야 합니다:

yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli

Arch Linux 사용자는 AUR에서 all-contributors-cli 패키지로도 설치할 수 있습니다.

The CLI is node based, if you don't wish to add a node dependency use the @all-contributors bot 🤖

2. 프로젝트 초기화

init을 사용하여 프로젝트를 초기화하고 몇 가지 질문에 답하십시오.

yarn all-contributors init # npx를 사용하시면, npx all-contributors init 

# 또는 bin에서 직접 실행
./node_modules/.bin/all-contributors init

3. 기여자 추가

yarn all-contributors add jfmengels doc
yarn all-contributors generate

코맨드에 대한 자세한 내용은 CLI 사용법을 참조하십시오.

4. 기여 문서 업데이트

CONTRIBUTING.md를 업데이트하거나 기여자가 직접 추가 할 수 있게 해주는 방법이 좋습니다. CLI 사용 설명서링크를 달아 주셔도 됩니다.

5. 선택적으로 scripts 필드를 package.json에 추가 시키는 방법

선택적으로 package.json 다음과 같은 scripts 필드에 다음과 같은 명령어를 추가 하시면,

예:

{
  "scripts": {
    "contributors:add": "all-contributors add",
    "contributors:generate": "all-contributors generate"
  }
}

다음과 같이 쉽게 코맨드를 사용하실 수 있습니다.

yarn contributors:add jfmengels doc

다음으로 읽을거리

← 개요설명서 →