기여자 온보딩은(는) 무엇을 하나요?
새로운 기여자에게는 세 가지가 필요합니다: 경로(CONTRIBUTING.md), 지도(레이블), 그리고 첫걸음(good first issues). 프로젝트의 실제 명령어를 기반으로 이 세 가지를 모두 구축하세요.
사용 시기
- "CONTRIBUTING.md를 작성해 주세요" / "기여자를 어떻게 유치할 수 있나요?"
- GitHub 레이블 생성 또는 정리
- Good first issue 작성, 또는 Hacktoberfest나 런칭 준비
사용하지 말아야 할 시기
- 재단을 위한 거버넌스 문서(GOVERNANCE.md, 헌장): 범위 외
- 행동 강령 텍스트: Contributor Covenant를 그대로 채택하세요; 다시 작성하지 마세요.
워크플로우
1. CONTRIBUTING.md
- 실제 명령어 찾기: 설정(
pip install -e ".[dev]",npm ci,composer install), 테스트, 린트/포맷, 빌드, 문서. CI 워크플로우를 읽으세요; 이것이 진실의 원천입니다. - 템플릿을 복사하고 모든 플레이스홀더를 채우세요. 문서화하는 각 명령어를 실행하거나 실행할 수 없었던 명령어를 명확히 표시하세요.
- 스캔 가능하게 유지하세요: 기여 방법(필요한 시간별), 설정, 테스트, 스타일, 커밋 컨벤션, PR 프로세스, 질문할 곳. CODE_OF_CONDUCT.md와 SECURITY.md에 링크하세요.
- "Good first issues" 아래에 5~10개의 구체적인 시작 작업을 추가하거나 레이블에 링크하세요.
2. 레이블
scripts/는 이 스킬의 디렉토리를 기준으로 합니다. 스크립트는 GitHub 자체를 호출하지 않습니다.
python3 scripts/labels.py generate > labels.json # 기본 세트
python3 scripts/labels.py generate --area cli --area docs --prefixed > labels.json
python3 scripts/labels.py validate labels.json # 문제가 있으면 exit 1
python3 scripts/labels.py commands labels.json --repo OWNER/NAME > apply-labels.sh
사용자에게 apply-labels.sh를 보여주고 실행하기 전에 승인을 요청하세요: 이 스크립트는 GitHub에서 레이블을 생성하거나 업데이트합니다(gh label create ... --force). 레이블을 삭제하지는 않습니다. 사용자가 이전 레이블을 제거하려면 gh label list로 목록을 확인하고 각 삭제를 확인받으세요.
GitHub의 good first issue와 help wanted 이름은 그대로 유지하세요: GitHub와 타사 사이트는 이들을 사용하여 초보자 작업을 표면화합니다.
3. Good first issues
후보 이슈를 가이드에 따라 재작성하세요. 각 항목에는 컨텍스트, 수정할 정확한 파일, 수용 기준, 테스트 방법, 도움 제공 안내가 포함되어야 합니다. GitHub에서 이슈를 편집하거나 레이블을 지정하기 전에 승인을 요청하고, 먼저 텍스트를 초안으로 제공하세요.
출력
- CONTRIBUTING.md (새로 작성 또는 업데이트) 및 검증된 명령어 vs 검증되지 않은 명령어 목록
labels.json및apply-labels.sh(사용자가 승인하지 않으면 실행되지 않음)- 초안 작성된 good first issue (마크다운 형식), 복사하여 붙여넣거나 승인 후
gh issue create --title ... --body-file ... --label "good first issue"로 생성 가능
기본 레이블 세트
| 그룹 | 레이블 |
|---|---|
| type (유형) | bug, enhancement, documentation, question, performance, refactor |
| contributor (기여자) | good first issue, help wanted |
| status (상태) | needs-triage, needs-repro, needs-info, confirmed, in-progress, blocked, stale |
| priority (우선순위) | priority: critical, priority: high, priority: low |
| resolution (해결) | duplicate, invalid, wontfix |
| dependencies (의존성) | dependencies, security, breaking-change |
--prefixed를 사용하면 type: bug, status: needs triage 스타일의 이름으로 전환됩니다. GitHub는 레이블 이름을 50자, 설명을 100자로 제한하며, validate는 두 제한과 6자리 16진수 색상, 대소문자 구분 없는 중복을 검사합니다.