코드 검토 및 승인

코드 검토는 현대 소프트웨어 개발의 핵심입니다. 동료가 소스 코드를 체계적으로 검사하여 초기 개발 단계에서 발견하지 못한 실수를 찾고 수정하는 과정입니다.

주요 목표는 다음과 같습니다.

• 코드 품질 향상: 버그, 보안 취약점, 설계상의 문제를 조기에 발견합니다.
• 지식 공유: 코드베이스에 대한 이해를 팀 전체에 넓힙니다.
• 멘토링: 숙련된 개발자가 주니어 개발자를 이끌고, 모두가 서로 다른 관점에서 배웁니다.

GitHub의 코드 검토 과정은 일반적으로 다음 단계를 따릅니다.

1. 작성자가 변경 사항과 함께 풀 리퀘스트(PR)를 만듭니다.
2. 작성자가 검토자를 지정하거나 검토를 요청합니다.
3. 검토자가 코드를 살펴보며 댓글과 제안을 남깁니다.
4. 작성자가 피드백을 반영하고 PR 브랜치에 새 커밋을 푸시합니다.
5. 검토자가 만족하면 변경 사항을 승인합니다.
6. 마지막으로 PR을 main 브랜치에 병합합니다.

좋은 코드 검토는 버그를 찾는 데서 끝나지 않고 프로젝트의 전반적인 상태를 개선하는 과정입니다. 검토할 때는 다음을 고려하세요.

• 정확성: 코드가 의도한 대로 작동하나요? 예외적인 경우도 처리하나요?
• 가독성: 이해하기 쉬운가요? 변수 이름이 명확한가요?
• 유지 보수성: 다른 사람이 나중에 이 코드를 쉽게 수정하거나 확장할 수 있나요?
• 성능: 명백한 비효율성이 있나요?
• 보안: 취약점이 새로 생기지는 않나요?

검토자의 피드백은 항상 건설적이고 예의 바른 방식이어야 합니다. 검토 대상은 코드를 작성한 사람이 아니라 코드라는 점을 기억하세요.

피드백을 제공하는 방법은 다음과 같습니다.

• 구체적으로 말하기: 코드의 정확한 줄을 지적하세요.
• '이유' 설명하기: '이것을 바꾸세요'라고만 하지 말고 바꿔야 하는 이유를 설명하세요.
• 해결책 제안하기: 다른 접근 방법이나 코드 조각을 제시하세요.
• 친절하게 말하기: 정중한 표현을 사용하고 선의로 행동했다고 가정하세요.

GitHub는 검토 과정을 효율적으로 진행할 수 있는 강력한 도구를 제공합니다.

• 줄 댓글: '변경된 파일' 탭에서 줄을 클릭하여 바로 댓글을 추가합니다.
• 제안: 작성자가 한 번의 클릭으로 적용할 수 있는 구체적인 코드 변경을 제안할 수 있습니다.
• 요약 검토: 마지막에 '댓글', '승인' 또는 '변경 요청' 상태로 요약 검토를 제출할 수 있습니다.

제안은 작고 명확한 개선 사항에 특히 유용합니다.

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

풀 리퀘스트의 작성자라면 피드백에 응답하는 것이 중요합니다. 이는 코드 개선에 적극적으로 참여하고 있다는 것을 보여 줍니다.

댓글에 대응할 때는 다음을 따르세요.

• 확인하기: '좋은 지적입니다!' 또는 '완료했습니다'라고만 답하더라도 모든 댓글에 답변하세요.
• 변경하기: PR 브랜치에 새 커밋을 푸시하세요. GitHub가 PR을 자동으로 업데이트합니다.
• 대화 해결하기: 댓글에 대응한 후 GitHub에서 해당 댓글을 '해결됨'으로 표시하세요.
• 질문하기: 제안을 이해하지 못했다면 설명을 요청하세요.

'승인' 상태는 검토자가 풀 리퀘스트의 변경 사항에 만족한다는 명확한 신호입니다. 많은 저장소는 PR을 병합하기 전에 하나 이상의 승인을 받도록 설정되어 있습니다.

승인은 검토자가 코드가 다음 조건을 충족한다고 판단한다는 의미입니다.

• 요구 사항을 충족합니다.
• 잘 작성되었고 유지 보수하기 쉽습니다.
• 중요한 우려 사항을 모두 해결했습니다.

통합해도 좋다는 신호입니다!

풀 리퀘스트를 병합하기 전에 추가 작업이 필요한 경우가 있습니다. 이때 검토자는 검토 상태로 '변경 요청'을 선택할 수 있습니다.

이 상태는 다음을 명확하게 전달합니다.

• 해결해야 할 병합 차단 문제가 있습니다.
• 변경 사항을 적용하고 검토자가 새로 승인할 때까지 PR을 병합할 수 없습니다.

문제가 중요하여 코드가 승인 가능한 상태가 되는 것을 막을 때 이 옵션을 사용하세요.

코드 검토를 최대한 효과적으로 활용하려면 작성자와 검토자 모두 몇 가지 모범 사례를 따라야 합니다.

• PR을 작게 유지하기: 작은 PR이 검토하기 더 쉽고 빠릅니다.
• 명확하게 설명하기: 작성자는 자세한 PR 설명과 맥락을 제공해야 합니다.
• 신속하게 대응하기: 검토자는 빠르게 검토하고, 작성자는 신속하게 응답하도록 노력해야 합니다.
• 자동화할 수 있는 작업은 자동화하기: 린터와 자동화된 테스트를 사용하여 검토 전에 간단한 문제를 발견하세요.
• 검토에서 배우기: 모든 검토를 배우고 개선할 기회로 여기세요.

지금까지 배운 내용을 바탕으로, 다음 중 코드 검토에 참여할 때 좋은 방법으로 여겨지는 것은 무엇일까요?

코드 검토와 GitHub의 승인 기능을 살펴보았습니다! 코드 품질과 지식 공유에 검토가 중요한 이유, 일반적인 검토 흐름, 좋은 검토 방법의 핵심 요소를 배웠습니다.

항상 건설적인 피드백을 제공하고 제안과 같은 GitHub 도구를 활용하며, 검토하고 피드백에 응답할 때 모범 사례를 따르세요. 승인과 '변경 요청'은 PR을 효과적으로 관리하는 데 중요한 신호입니다.

이러한 기술을 계속 연습하여 소중한 협업자가 되어 보세요!