PR 작업 내용 작성하기

🪴 현업 개발자가 말하는 좋은 pr 이란

실무를 위한 pr 과 그에 대한 제대로 된 코드 리뷰를 받아본 적이 없는 신입 개발자인 나에게는 pr 의 정의와 현업 개발자의 블로그들이 도움이 많이 되었다.

PR 이란,

PR이란, Pull Request의 약자로, 기존 Github 저장소에 보관된 코드 베이스에서 내 작업으로 인해 생긴 변경사항들, 즉 코드 라인들의 추가와 삭제를 코드 베이스에 포함시켜달라고 보내는 요청이다.

좋은 PR 이란,

1. 리뷰어를 배려하라
   • 커밋 컨벤션 지키기
   • 리뷰 가이드 라인 잘 작성하기
   • 리뷰 가능 여부 태그 설정하기

2. 내가 쓴 코드는 내가 책임져라
   • 내가 만들어 낸 변경사항에 대한 내용은 100% 이해하기

3. 반드시 테스트하라
   • 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작하도록 하기

4. 자신의 예상 작업량을 잘 측정하라
   • UI 컴포넌트 개발이라면 그 내부에 필요한 하위 컴포넌트들을 성질 단위로 나누거나
   • API 개발이라면 그 기능과 동작에 따라 분리하여 작업하는 등 잘 쪼개기
   • feature/#1234 처럼 브랜치를 만든 뒤, 이 하위에 feature/#1234/develop 과 feature/#1234/feature/separate-task 와 같이 새로운 베이스 브랜치와 세부 작업에 대한 브랜치를 두고 작업하여 작은 PR 만들기

참고한 블로그

좋은 PR에 대한 단상🤔

---

🪴 내가 작성해온 PR

PR 목록

PR 내용

GitHub PR 링크 👇
Add: 헤더 반응형 UI 및 기능 추가
Fix: 헤더 반응형 / 토글메뉴 로직 수정 및 컴포넌트 분리

PR 스크린샷