개발환경 / / 2023. 11. 3. 10:25

[Github] 코드 리뷰 쉽게 하는 방법

❓ 개요

코드 리뷰를 해보려는데 어떻게 해야되는지 헷갈리는 경우가 많습니다. 

팁들을 모아 코드를 리뷰하는 방법에 대해 알아보겠습니다.

먼저 Github 레포지토리에서 PR에 들어가게 되면 위의 이미지와 같이 확인이 가능합니다.

 

그 다음 Files changed를 누르면 아래와 같은 이미지로 나타나는데

이제 코드 리뷰를 하기 전 쉽게 소스코드들을 따라갈 수 있게 "." 물음표 옆에 위치한 점을 누르면 

web editor

이렇게 웹 에디터가 나타납니다!

이러면 소스코드를 따라가면서 파악하기도 쉽고, (Ctrl + 클릭)

보기에도 좋습니다.

 

이제 코드 옆 + 버튼을 클릭하게 되면

public class 옆 + 아이콘 클릭
의견을 작성한 뒤 댓글 추가

이렇게 리뷰를 할 수 있고, 댓글 추가를 누르면 리뷰가 달리게 됩니다!

 

++

추가로 이런 리뷰들이 많이 달리면 코드를 보기가 어려운 경우가 종종 있는데

fileChanges에서 i 단축키를 활용해 리뷰들을 일괄로 닫을 수 있습니다.

 

만약 . 단축키로 web vscode로 전환이 되지 않는다면 github.com -> github.dev로 변경하면 됩니다.

https://docs.github.com/ko/codespaces/the-githubdev-web-based-editor

 

github.dev 웹 기반 편집기 - GitHub Docs

github.dev 웹 기반 편집기를 사용하여 파일을 편집하고 변경 내용을 커밋할 수 있습니다.

docs.github.com