PR을 작성하는 좋은 방법

스프링에 대한 심도 있는 공부를 하던 도중 스프링 부트를 이용해서 개인적으로 프로젝트를 진행하면 좋을 것 같다는 생각에 Git을 이용하여 진행하는 중이다. 우연찮게 좋은 기회를 얻어 코드 리뷰를 받게 되었는데 리뷰를 해주시는 분이 보시기에 좋은 PR을 작성해야 할 것 같아 따로 공부를 하게 되었다.

 

PR이란 무엇인가

내가 작업한 코드가 있으니 동료들에게 내 브랜치를 merge 전 검토 후 병합 요청을 받는 과정이다.

 

PR을 왜 해야 하는가?

• 협업을 하는 경우 내가 작성한 코드가 전체적인 프로젝트에 영향을 미칠 수 있기 때문에 master 브랜치로 merge 전 다 같이 리뷰를 하며 검증하는 구간이다.
• 전체적인 프로그램의 오류를 미리 방지할 수 있다.
• => 잘못된 부분이 있을 경우 PR commit을 되돌릴 수 있다.

좋은 PR을 작성하는 방법

규모

> 너무 많은 코드는 리뷰어에게 부담이 된다. 

> 최대한 단순하게 나눠서 작성

 

제목 

> 작업의 단위는 적게 하되 한 문장으로 요약해서 작성

 

내용

> 구체적으로 쓰기

• 어떤 것을 개발했는지?
• 시간이 짧게 걸릴만큼 간결한가?

참고 : https://brunch.co.kr/@anonymdevoo/9

6. Github으로 협업하는 법