Skip to content

Pull Request Convention

윤이진 edited this page Nov 16, 2021 · 2 revisions

지켜야 할 사항

  • PR에 대한 목적을 명시한다 (코드 리뷰가 목적인지, 버그 픽스가 목적인지 등)
  • 변화 단위를 작게 유지한다 (기준 줄 수 → 300~400줄)
    • 너무 많은 수정사항이 PR에 포함되면 리뷰에서 결함을 찾기 힘들어진다
  • 의미있는 PR을 만들기에 충분한 정보를 텍스트로 제공한다
    • 무슨 이유로 어떻게 코드를 변경했는지
    • 어떤 위험이나 우려가 발견되었는지
    • 어떤 내용을 중심으로 보면 좋을지
    • 위의 정보들을 리뷰어가 텍스트만 봐도 이해할 수 있도록 제공해야 한다.
  • 리뷰가 확인된 PR은 본인이 스스로 Merge한다.

Pull Request Template

## Motivation 🤔

- 변화/추가를 하게 된 계기를 적는다
- 에러의 경우 스크린샷을 첨부하면 좋다

<br>

## Key Changes 🔑

- 주요 변경 사항을 적는다

<br>

## To Reviewers 🙏

- 리뷰어에게 중점적으로 봐줬으면 좋겠는 내용을 적는다
- 혹은 리뷰어와 얘기해보고 싶은 이슈를 적는다