Reviewing proposed changes in a pull request

Understanding the purpose of the pull request

Understanding the motivation behind a pull request helps you keep your review targeted and meaningful. It also helps you provide feedback that aligns with the pull request author’s intent and the project's goals.

You have several options to better understand the context and rationale for proposed changes.

Using the pull request sidebar for context

In the pull request sidebar, you can find valuable context, including:

• Linked issues or discussions: Review these to understand the problems or goals that the pull request aims to address. You can also gather information about background, design decisions, or current debates.
• Linked projects or milestones: Review how this pull request fits within larger projects or upcoming releases.

Use this information to frame your review and check if the goals of the pull request align with the original intent.

Using 공동 파일럿 채팅 to understand the rationale

You can ask 공동 파일럿 채팅 for help understanding the pull request’s intent or clarifying any part of the change.

1. At the top right of the pull request page, click the button next to the search bar.

   공동 파일럿 채팅 is displayed, with the pull request attached as context to the prompt window.

2. In the prompt box, type a question and press Enter. For example, you could enter:

   • What problem does this pull request solve?
   • Why were these changes needed?
   • Summarize the goals of this PR based on the linked issue.
   • How does this PR relate to issue ISSUE-URL?

공동 파일럿 채팅 can help you clarify the bigger picture before you start line-level review.

Starting a review

1. 리포지토리 이름에서 Pull requests를 클릭합니다.

   

2. 끌어오기 요청 목록에서 검토하려는 끌어오기 요청을 클릭합니다.

3. 끌어오기 요청에서 파일 변경됨을 클릭합니다.

   To change the format of the diff view in this tab, click and choose the unified or split view. The choice you make will apply when you view the diff for other pull requests.

   

   You can also hide whitespace differences. The choice you make only applies to this pull request and will be remembered the next time you visit this page.

4. Optionally, filter the files to show only the files you want to review or use the file tree to navigate to a specific file.

5. 설명을 추가할 코드 줄을 마우스로 가리키고 파란색 설명 아이콘을 클릭합니다.

   

6. 선택적으로 여러 줄에 설명을 추가할 수 있습니다. 줄 범위를 선택하려면 메모할 첫 번째 줄의 줄 번호를 클릭한 다음 마지막 줄로 끌어다 놓거나 Shift 키를 누 른 채 마지막 줄 번호를 클릭합니다. 그런 다음 메모할 마지막 줄에서 파란색 메모 아이콘을 클릭할 수 있습니다. 또는 설명을 추가할 첫 번째 줄 옆에 있는 파란색 메모 아이콘을 클릭한 다음, 설명을 추가할 마지막 줄로 끌어다 놓을 수 있습니다.

7. 주석 필드에 주석을 입력합니다.

8. 필요에 따라 줄에 대한 특정 변경을 제안하려면 을 클릭한 다음, 제안 블록 내에서 텍스트를 편집합니다.

   

9. 파일에 직접 메모를 달려면 파일 오른쪽에서 을(를) 클릭하고 메모를 입력합니다.

   

10. When you're done, click Start a review. If you have already started a review, you can click Add review comment.

Before you submit your review, your line comments are pending and only visible to you. You can edit pending comments anytime before you submit your review. To cancel a pending review, including all of its pending comments, click Review changes, then click Abandon review.

Reviewing dependency changes

If the pull request contains changes to dependencies, you can use the dependency review for a manifest or lock file to see what has changed. You can also check whether the changes introduce security vulnerabilities. See Reviewing dependency changes in a pull request.

1. 끌어오기 요청에서 파일 변경됨을 클릭합니다.

   

2. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button.

   

3. 종속성을 변경하지 않는 매니페스트 또는 잠금 파일이 변경되거나, GitHub가 구문 분석할 수 없고 결과적으로 종속성 검토에 표시되지 않는 종속성이 있을 수 있으므로 원본 diff도 검토할 수 있습니다.

   원본 diff 보기로 돌아가려면 단추를 클릭합니다.

   

Marking a file as viewed

After you finish reviewing a file, you can mark the file as viewed. The file will collapse. If the file changes after you view the file, it will be unmarked as viewed.

1. 끌어오기 요청에서 파일 변경됨을 클릭합니다.

   

2. On the right of the header of the file you've finished reviewing, select Viewed.

   

Submitting your review

After you've finished reviewing all the files you want in the pull request, submit your review.

1. 끌어오기 요청에서 파일 변경됨을 클릭합니다.

   

2. 변경된 코드 위에서 변경 내용 검토를 클릭합니다.

   

3. 제안된 변경 내용에 대한 피드백을 요약한 설명을 입력합니다.

4. Select the type of review you'd like to leave:

   • Select Comment to leave general feedback without explicitly approving the changes or requesting additional changes.
   • Select Approve to submit your feedback and approve merging the changes proposed in the pull request.
   • Select Request changes to submit feedback that must be addressed before the pull request can be merged.

5. 리뷰 제출을 클릭합니다.