Github - Suggestion을 사용해서 코드 리뷰를 진행해보자

다른 사람과 같이 협업할 때는 PR을 통해 코드 리뷰를 진행하는 경우가 많다. 코드 리뷰를 할 때, 어떠한 코드를 다르게 변경하는 것을 제안하는 경우가 있는데, 일반적으로 위 사진처럼 리뷰를 남기곤 한다. 변경 사항이 단순할 때는 위 방식으로도 충분히 의미 전달이 되지만, 변경 사항이 조금 복잡할 때는 직접 수정된 코드를 보여주고 싶을 때가 많다. 그럴 때는 Github에서 제공하는 Suggestion 기능을 사용하면 도움이 될 것이다.

리뷰를 작성하는 에디터 상단에는 사진에서 보이듯 Add a suggestion 버튼이 있다.

해당 버튼을 누르면, 위처럼 마크다운의 코드블럭의 언어가 suggestion으로 지정된 양식이 나온다. 이 안에 변경사항을 적어주면, 변경사항을 직관적으로 보여주게 된다.

위처럼 어떻게 변경하길 원하는지 직관적으로 보여줄 수 있다.

또한, 등록된 리뷰에서 변경 사항을 바로 커밋할 수도 있기에, 리뷰를 반영하기도 편해진다.

위처럼 여러 줄의 코드에 대해서도 적용이 가능해서 더욱 유용할 것이다.