Pull Request

이 기능을 사용하는 이유는?

• 시간 절약: 변경 사항을 기반으로 자세한 PR 설명을 자동으로 생성합니다.
• 일관성 유지: 모든 PR이 일관된 형식을 따르도록 합니다.
• 협업 개선: 잘 구조화된 설명으로 리뷰어에게 명확한 컨텍스트를 제공합니다.
• 워크플로우 간소화: IDE를 떠나지 않고 PR을 생성합니다.

작동 방식

Bob은 브랜치 변경 사항, 커밋 기록 및 브랜치 이름을 분석하여 작업의 목적과 범위를 이해합니다. 그런 다음 변경 사항을 요약하는 의미 있는 PR 제목과 자세한 설명을 생성하여 리뷰어가 PR의 컨텍스트와 목적을 쉽게 이해할 수 있도록 합니다. 생성 후 제출하기 전에 PR 설명을 검토하고 편집할 수 있습니다.

PR 생성 프로세스는 대화형이며 PR을 생성하기 전에 대상 브랜치와 원격 저장소를 선택할 수 있습니다.

시작하기

전제 조건

• 변경 사항이 브랜치에 커밋되어 있어야 합니다.
• 원격 저장소에 대한 푸시 액세스 권한이 있어야 합니다.

기본 사용법

PR 플로우를 시작하는 3가지 옵션 중에서 선택할 수 있습니다:

• Source Control 패널에서 PR 아이콘을 클릭합니다.
• 명령 팔레트(Cmd + Shift + P(Mac), Ctrl + Shift + P(Windows/Linux))를 사용하고 "Bob: Generate PR"을 검색합니다.
• Bob 채팅 인터페이스에 /create-pr을 입력합니다.

그러면 Bob이 다음 단계를 안내합니다:

1. 병합하려는 기본 브랜치를 선택합니다. Bob은 가장 가능성이 높은 세 개의 브랜치를 제안합니다.
2. 여러 원격이 있는 경우 원격 저장소를 선택합니다.
3. 생성된 PR 설명과 제목을 검토합니다.
4. PR을 생성합니다.
5. 채팅에서 새로 생성된 PR에 대한 링크를 받습니다.

PR 설명 템플릿 사용

Bob은 Pull Request 설명을 생성할 때 프로젝트의 기존 PR 템플릿을 자동으로 인식하고 사용합니다. 이를 통해 PR이 팀의 확립된 표준과 일관성을 유지합니다. Bob이 프로젝트에서 여러 PR 템플릿을 감지하면 Pull Request에 적용할 템플릿을 선택할 수 있습니다.

템플릿 감지

Bob은 프로젝트 루트를 기준으로 다음 위치에서 PR 템플릿을 찾습니다:

1. ${cwd}/pull_request_template.md
2. ${cwd}/docs/pull_request_template.md
3. ${cwd}/.github/pull_request_template.md
4. ${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
5. ${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
6. ${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

Bob이 여러 템플릿을 찾으면 PR 설명에 사용할 템플릿을 선택하도록 사용자에게 요청합니다.

기본 템플릿

프로젝트에서 템플릿을 찾을 수 없으면 Bob은 다음을 포함하는 내장 템플릿을 사용합니다:

• 브랜치 이름에서 파생된 설명적인 제목
• 변경 사항 요약
• 주요 구현 세부 정보
• 테스트 정보
• 관련 링크 또는 참조

생성된 설명 편집

PR 설명을 생성하면 Bob이 채팅에 직접 표시합니다. 그런 다음 다음을 수행할 수 있습니다:

• 확인하고 계속: PR 생성을 진행하기 위해 설명을 그대로 승인합니다.
• 변경 요청: 채팅에 피드백을 입력하면 Bob이 입력 내용을 바탕으로 설명을 재생성합니다. 확인하기 전에 필요한 만큼 반복할 수 있습니다.

템플릿 사용자 정의

Bob의 PR 생성으로 최상의 결과를 얻으려면:

• 템플릿에서 명확한 섹션 제목 사용(예: ## 요약, ## 변경 사항)
• 컨텍스트를 제공하는 자리 표시자 텍스트 추가(예: <!-- 이 PR의 목적 설명 -->)
• 테스트 지침 및 관련 문제에 대한 섹션 추가 고려

팁 및 모범 사례

• Bob이 더 정확한 PR 설명을 생성하는 데 도움이 되도록 설명적인 브랜치 이름을 사용하세요.
• PR을 생성하기 전에 생성된 설명을 검토하고 편집하세요.