📌 참고: 이 문서는 awesome Claude Code 문서의 원문 + 레퍼런스입니다.

• 원문 링크를 직접 사용하셔도 됩니다
• 이 파일을 .claude/skills/ 하위에 복사하여 스킬로 등록할 수도 있습니다

(2026.03.15 기준)

GitHub CLI를 사용하여 Pull Request 생성하는 방법

이 가이드는 프로젝트에서 GitHub CLI를 사용하여 Pull Request를 생성하는 방법을 설명합니다.

중요: 모든 PR 제목과 설명은 영어로 작성해야 합니다.

사전 요구사항

1. GitHub CLI가 설치되어 있지 않다면 설치합니다:

   # macOS
   brew install gh
   
   # Windows
   winget install --id GitHub.cli
   
   # Linux
   # https://github.com/cli/cli/blob/trunk/docs/install_linux.md 의 안내를 따르세요
   

2. GitHub 인증을 수행합니다:

   gh auth login
   

새 Pull Request 생성하기

1. 먼저 @.github/pull_request_template.md 의 템플릿을 참고하여 PR 설명을 준비합니다.

2. gh pr create --draft 명령어를 사용하여 새 Pull Request를 생성합니다:

   # 기본 명령어 구조
   gh pr create --draft --title "✨(scope): Your descriptive title" --body "Your PR description" --base main
   

   더 복잡한 PR 설명을 적절한 포맷으로 작성하려면, 정확한 PR 템플릿 구조와 함께 --body-file 옵션을 사용합니다:

   # 적절한 템플릿 구조로 PR 생성
   gh pr create --draft --title "✨(scope): Your descriptive title" --body-file .github/pull_request_template.md --base main
   

모범 사례

1. 언어: PR 제목과 설명에는 항상 영어를 사용합니다

2. PR 제목 형식: 이모지와 함께 Conventional Commit 형식을 사용합니다

   • 항상 제목 앞에 적절한 이모지를 포함합니다
   • 실제 이모지 문자를 사용합니다 (:sparkles: 같은 코드 표현이 아닌)
   • 예시:
     • ✨(supabase): Add staging remote configuration
     • 🐛(auth): Fix login redirect issue
     • 📝(readme): Update installation instructions

3. 설명 템플릿: 항상 @.github/pull_request_template.md 의 PR 템플릿 구조를 사용합니다

4. 템플릿 정확성: PR 설명이 템플릿 구조를 정확히 따르는지 확인합니다:

   • PR-Agent 섹션(pr_agent:summary 및 pr_agent:walkthrough)을 수정하거나 이름을 변경하지 마세요
   • 모든 섹션 헤더를 템플릿에 나타난 그대로 유지합니다
   • 템플릿에 없는 커스텀 섹션을 추가하지 마세요

5. Draft PR: 작업이 진행 중일 때는 Draft로 시작합니다

   • 명령어에 --draft 플래그를 사용합니다
   • 완료되면 gh pr ready를 사용하여 리뷰 준비 상태로 전환합니다

흔한 실수 피하기

1. 영어 이외의 텍스트 사용: 모든 PR 내용은 영어로 작성해야 합니다
2. 잘못된 섹션 헤더: 항상 템플릿의 정확한 섹션 헤더를 사용하세요
3. 커스텀 섹션 추가: 템플릿에 정의된 섹션만 사용하세요
4. 오래된 템플릿 사용: 항상 현재의 @.github/pull_request_template.md 파일을 참조하세요

누락된 섹션

일부가 "N/A" 또는 "None"으로 표시되더라도 항상 모든 템플릿 섹션을 포함하세요.

추가 GitHub CLI PR 명령어

PR 관리에 유용한 추가 GitHub CLI 명령어들입니다:

# 내가 작성한 열린 Pull Request 목록 보기
gh pr list --author "@me"

# PR 상태 확인
gh pr status

# 특정 PR 보기
gh pr view <PR-NUMBER>

# PR 브랜치를 로컬에 체크아웃
gh pr checkout <PR-NUMBER>

# Draft PR을 리뷰 준비 상태로 전환
gh pr ready <PR-NUMBER>

# PR에 리뷰어 추가
gh pr edit <PR-NUMBER> --add-reviewer username1,username2

# PR 병합
gh pr merge <PR-NUMBER> --squash

PR 생성 시 템플릿 사용하기

일관된 설명으로 PR 생성을 간소화하려면 템플릿 파일을 만들 수 있습니다:

1. PR 템플릿으로 pr-template.md 파일을 생성합니다
2. PR 생성 시 해당 파일을 사용합니다:

gh pr create --draft --title "feat(scope): Your title" --body-file pr-template.md --base main

관련 문서

• PR Template
• Conventional Commits
• GitHub CLI documentation