Github - Suggestion

안녕하세요. 그린입니다 🍏

이번 포스팅에서는 Github의 Suggestion 기능에 대해 알아보고 한번 실습해보려 합니다!

 

이번 포스팅은 진짜 아주 간단합니다요 ☺️

 

아니.... 깃헙을 그렇게나 밥먹듯 쓰는데, 항상 쓰는 기능만 쓰니까 Suggestion이라는 기능을 얼핏 들어봤지 쓸 생각을 아예 1도 안해봤어요 😇

 

그러다 한번 써보니까 생각보다 많이 편하고 PR 올린 사람이나 리뷰하는 사람이나 공수가 더 적고 편리하더라구요! 그래서 한번 알아봤습니다ㅎㅎ

 

---

Suggestion

우선 우리는 Pull Request를 활용해 다른 브랜치에서 변경된 사항들을 다른 브랜치에 적용시키기 위해, 보통은 베이스 브랜치에 적용하겠죠?

리뷰를 요청하게 됩니다.

 

아래와 같이 말이죠!

 

 

리뷰어는 저 혼자 테스트해보는거라 지정은 안해보겠습니다ㅎㅎ

 

이렇게 다들 밥먹듯 하는 PR을 생성하고 이제 리뷰어들이 해당 PR에 대해 코드 리뷰를 진행하게 됩니다.

 

보통은 뭔가 컨벤션이 어긋나거나 수정을 요하는 코멘트를 달 경우 아래와 같이 코멘트를 달며 리뷰를 시작하고 팬딩된 리뷰들을 Review Changes를 통해 요청시키죠?

 

 

그럼 이렇게 PR 페이지에서 나타나게 됩니다.

 

 

 

보통은 이러면 PR을 올린 담당자가 해당 코멘트를 보고 수정을 위해 본인의 로컬 레포에서 해당 코드들의 수정을 반영하고 다시 add > push 하는 작업을 거쳐 리뷰를 반영하게 됩니다.

 

즉, 여기서 다시 로컬에서 작업하고 하는것이 귀찮을 수 있습니다.

 

이럴때 Suggestion 기능을 활용하면 보다 편리하게 해볼 수 있어요!

 

물론, 이건 리뷰어가 귀찮을 수는 있지만요 ☺️

 

리뷰 시 해당 문서 아이콘을 클릭해 suggestion을 사용합니다.

 

 

그럼 이제 제안할 수정된 코드를 리뷰어가 작성합니다.

 

 

물론 여기서 제안할 코드를 작성하고 코멘트를 덧붙여서 왜 이런 코드를 제시했는지 등 의견을 남길 수도 있어요!

 

그러고 이제 Review Changes로 팬딩된 제안 및 리뷰 코멘트들을 반영하면 아래와 같이 PR 페이지에 나타납니다.

 

 

여기서 담당자는 이제 해당 제안을 확인하여 받아들일지 무시할지 선택해요.

 

그럼 기본적으로 저 Commit suggestion 버튼을 눌러 반영할 수 있어요.

 

 

이렇게 커밋 메시지를 작성하고 Commit changes를 누르게 되면 바로 반영이 됩니다!

 

 

반영이 되어 커밋 로그가 추가된게 보이시죠!?

 

이렇게 로컬을 가지 않아도 쉽게 바로 반영할 수 있다는 장점이 있어요!

 

근데 저 Commit suggestion 옆에 Add suggestion to batch라는 버튼은 뭘까요?

 

 

이렇게 여러 제안이 있을 경우 한번에 합쳐서 처리하기 위한 기능입니다.

해당 버튼은 그냥 PR 페이지에서 활성화가 되지 않은 경우에는 파일 탭에서 활성화를 시켜 사용하라고 노티를 줍니다.

 

그래서 해당 File Changed로 접근하여 활성화가 된 상태에서 수락할 제안을 해당 버튼을 눌러줍니다.

 

 

누르면 이렇게 Pending in batch로 상태가 변경됩니다.

즉, 여러개를 한번에 처리하기 위해 저장시켜놓는것이죠!

 

 

그 후, 상단에서 Commit suggestions 버튼을 눌러 하나의 커밋으로 적용할 수 있어요.

 

 

그럼 이렇게 제안들이 모두 반영된 상태가 된것이죠!

 

그러고 이제 해당 파일을 다시 확인해보면, 정상적으로 로컬에서 하지 않아도 모두 잘 반영이 된것을 볼 수 있습니다!

 

 

 

아주아주 간단하죠!?ㅎㅎ

 

이렇게 로컬까지 담당자가 다시 작업하지 않아도 리뷰어가 제안한걸 바로 깃헙에서 반영 및 변경할 수 있는 편리한 Suggestion 기능이였습니다 😃

 

---

마무리

정말 밥먹듯이 사용하는것만 사용하다보니 이렇게 쉽고 유용하고 오래전부터 지원되던걸 사용해볼 생각을 안했네요ㅎㅎ..

익숙해지는게 참 무서운것 같아요!

 

---

레퍼런스

끌어오기 요청에 피드백 통합 - GitHub Docs