다른 사용자가 변경 내용을 검토할 수 있도록 지원

끌어오기 요청을 사용하여 변경 내용에 대한 명확한 컨텍스트를 제공하고 팀에 정보를 제공하여 공동 작업 및 검토 품질을 향상할 수 있습니다.

이 문서의 내용

끌어오기 요청을 만들 때 팀에 변경 내용을 검토하고 피드백을 제공하도록 요청합니다. 이 가이드에서는 공동 작업과 리뷰의 품질을 향상할 수 있도록 팀을 쉽게 검토하고 정보를 유지할 수 있는 끌어오기 요청을 만드는 모범 사례를 제공합니다.

변경 내용을 검토하기 쉽게 만들기

끌어오기 요청의 명확한 컨텍스트를 사용하면 검토자가 변경한 내용과 중요한 이유를 빠르게 확인할 수 있습니다. 이렇게 하면 검토 프로세스가 더 빠르고 원활해지고 앞뒤로 왔다 갔다 하는 일이 줄며 팀이 더 나은 피드백을 제공하고 자신감 있는 결정을 내리는 데 도움이 됩니다. 끌어오기 요청 만들기에 대한 자세한 내용은 끌어오기 요청 만들기을(를) 참조하세요.

작은 PR 작성

단일 목적을 충족하는 작고 집중적인 끌어오기 요청을 만드는 것을 목표로 합니다. 더 작은 끌어오기 요청은 더 쉽고 빠르게 검토 및 병합하고, 버그를 도입할 공간을 줄이고, 변경 내용의 보다 명확한 기록을 제공합니다.

먼저 사용자 고유의 끌어오기 요청 검토

제출하기 전에 사용자 고유의 끌어오기 요청을 검토, 빌드 및 테스트합니다. 이렇게 하면 다른 사용자가 검토를 시작하기 전에 누락되었을 수 있는 오류 또는 오타를 잡을 수 있습니다.

컨텍스트 및 참고 자료 제공

검토자가 끌어오기 요청이 수행하는 작업을 빠르게 이해할 수 있도록 끌어오기 요청에 대한 명확한 제목과 설명을 작성합니다. 끌어오기 요청 본문에 다음을 포함합니다.

  • 끌어오기 요청의 목적
  • 변경된 내용에 대한 개요
  • 문제 추적 또는 이전 대화와 같은 추가 컨텍스트에 대한 링크

검토자를 돕기 위해 필요한 피드백 유형을 공유합니다. 예를 들어 간단히 보기나 심층 비판이 필요한가요? 또한 GitHub Copilot을 사용하여 끌어오기 요청의 요약을 생성할 수 있습니다. 이 문서의 뒷부분에 있는 GitHub Copilot을 사용하여 끌어오기 요청 요약 생성을 참조하세요.

끌어오기 요청이 여러 파일에 대한 변경 내용으로 구성된 경우 검토자에게 파일을 검토할 순서에 대한 지침을 제공합니다. 시작할 위치와 검토를 진행하는 방법을 권장합니다.

팀 정보 유지

끌어오기 요청은 문서 코드 변경 이상의 작업을 수행할 수 있습니다. 또한 팀과 관리자에게 작업 상태에 대한 정보를 유지할 수 있는 강력한 방법입니다. 끌어오기 요청에서 진행률을 표시함으로써 별도의 업데이트에 대한 필요성을 줄이고 모든 사용자가 계속 정렬되도록 할 수 있습니다.

GitHub Copilot을 사용하여 끌어오기 요청 요약 생성

Note

GitHub Copilot 구독이 필요합니다. 자세한 내용은 "GitHub Copilot이란?"을(를) 참조하세요.

Copilot를 사용하여 GitHub에서 끌어오기 요청 요약을 생성할 수 있습니다. 요약을 사용하여 검토자가 변경 내용을 이해하는 데 도움이 될 수 있습니다.

  1. GitHub에서 끌어오기 요청을 만들거나 기존 끌어오기 요청으로 이동합니다.

    Note

    GitHub Copilot은(는) 끌어오기 요청 설명의 기존 콘텐츠를 고려하지 않으므로 빈 설명으로 시작하는 것이 좋습니다.

  2. 끌어오기 요청 요약을 추가할 텍스트 필드로 이동합니다.

    • 새 끌어오기 요청을 만드는 경우 "설명 추가" 필드를 사용합니다.
    • 기존 끌어오기 요청에 설명을 추가하는 경우 여는 주석을 편집합니다.
    • 요약을 주석으로 추가하는 경우 끌어오기 요청 페이지 아래쪽의 "주석 추가" 섹션으로 이동합니다.

  3. 텍스트 필드의 머리글에서 을(를) 선택한 다음 요약을 클릭합니다.

    끌어오기 요청 생성하기 양식 스크린샷 Copilot 아이콘이 강조 표시되고 "요약" 명령과 함께 상자가 나타납니다.

  4. GitHub Copilot이(가) 요약을 생성할 때까지 기다린 다음 결과를 신중하게 검사합니다.

  5. 끌어오기 요청을 보는 데 도움이 되는 컨텍스트를 추가합니다.

  6. 설명이 만족스럽다면 새 끌어오기 요청에서 끌어오기 요청 만들기를 클릭하거나 기존 설명을 편집하는 경우 주석을 업데이트합니다.

끌어오기 요청을 관련 문제 또는 프로젝트 보드에 연결하여 작업이 더 큰 프로젝트에 어떻게 적합한지 보여 줍니다.

  • 설명에 Closes ISSUE-LINK와 같은 키워드를 추가하여 끌어오기 요청이 병합될 때 문제를 자동으로 연결하고 닫습니다.
  • Projects를 사용하여 작업을 추적하고 끌어오기 요청에서 프로젝트에 연결하여 진행 상황을 한 곳에서 쉽게 추적할 수 있습니다. Projects 정보을(를) 참조하세요.

레이블을 사용하여 상태 강조 표시

끌어오기 요청에 상태 레이블을 추가하여 검토, 차단, 진행 중인지 여부를 표시합니다. 이렇게 하면 검토자가 작업의 상태를 한눈에 파악할 수 있습니다. 자세한 내용은 레이블 관리을(를) 참조하세요.