Home
All Posts
🗣️

함께 일하기 좋은 PR 본문 (feat. 현업자의 피드백)

Created
2024/04/17
Tags
Communication
Category
Project
2 more properties

기존의 본문 내용

중간에 보면 스타일 버그를 어떻게 해결했는지 서술했다.

현업 개발자의 조언

굳이 PR 본문에는 그 버그를 어떻게 해결했는지 상세하게 쓰진 않는 편이다. 어떻게 해결했는지는 코드에 있을테니 코드로 말한다.
근데 조금 까다롭거나 이 코드만으로 어떻게 해결한거지? 싶은 변경사항이라면, PR 본문에 근거나 설명을 기재한 문서를 링크로 연결해 놓고 변경된 코드를 언급하면서 설명하기도 한다.
그렇다고 PR본문에 WHY와 HOW를 제외한 WHAT만 쓰는건 아니다. WHY도 적기는 한다. 예를 들어, 작업 배경 (~하기 때문에 ~한 이슈 발생) + 고려한 부분과 문제 상황 및 해결한 방향. 이렇게 적기도 한다.
작업 배경은 버그 픽스나 문제 해결이 아니면 잘 안 쓰는 편이다. 대부분의 PR의 작업 배경은 기능 구현이니까 굳이 쓸 필요가 없기에 (기능 구현 작업 배경은 다들 웬만하면 알고 있으니까)

수정한 본문 내용

LGTM