PR Template 개선에 대한 아이디어

[HanGyeongjun]

최근 PR 작성 시 현재 PR 템플릿에 있는 항목으로만은 다음과 같은 문제가 있다고 느꼈습니다.

• Assginee는 PR 내용에 대해 자세히 설명하기 어렵다.
• Reviewer는 PR 내용에 대해 한번에 이해하기 어렵다.

---

내용이 짧거나 단순한 작업이면, 현재 관련 이슈, 구현/변경 사항, 스크린샷 3가지 항목으로도 이해가 가능합니다.
하지만 기능이 복잡해지거나 길어지면 추가 컨텍스트 없이는 빠른 시간 안에 코드를 이해하는 것이 상대적으로 어려워지는 문제가 생길 수 있습니다.
또한 Assignee가 의도하지 않은 방향으로 이해하거나 필요한 테스트를 하지 못하는 상황이 발생할 수 있다고 생각합니다.

---

현재 템플릿을 유지하더라도 Assignee는 원한다면 다른 내용이 포함된 구체적인 PR을 작성할 수 있습니다.
다만 이 방법은 Assignee가 더 많은 시간을 할애해야 하고, 각 PR간 일관성이 떨어지게 된다는 또 다른 문제를 야기합니다.
그래서 현재 탬플릿보다 보다 내용을 구체적으로 작성할 수 있는 개선된 템플릿이 필요하다고 생각합니다.

---

이를 위해 몇 가지 레퍼런스를 조사했습니다.
뱅크샐러드 코드리뷰 문화
공비서 코드리뷰 문화
이 중 두 번째 공비서의 PR 템플릿에서 참고할 만한 부분이 많아보입니다.
우리 프로젝트에 봇, 자동화 태그 등을 적용하기에는 현실적인 어려움이 있기에 PR 템플릿 정도만 참고하면 PR 내용의 개선, 코드리뷰의 속도와 정확성 측면에서 긍정적인 영향을 줄 것 같습니다.

---

그래서 다음과 같이 변경된 PR 템플릿을 제안합니다.
기존 템플릿보다 구체적 작성이 가능하되, 작성에 지나치게 오랜 시간이 걸리지 않도록 조정했습니다.

1. 해결하려는 이슈 (관련 이슈, 디자인 파일 등)
2. 핵심적인 변경사항
3. 그 외의 변경사항 (옵셔널)
4. 테스트 필요 항목
5. Reviewer에게 바라는 점 (신경써서 볼 부분, 추가 아이디어 등)
6. 스크린샷

---

더 좋은 템플릿 구성이나, 추가 혹은 제거할 항목에 대한 아이디어가 있으면 코멘트로 남겨 주시면 감사하겠습니다!