Skip to content

docs: PR 템플릿 섹션별 작성 기준 명시 - #71

Merged
mingdodev merged 3 commits into
mainfrom
docs/pr-template-reviewer-notes
Sep 1, 2026
Merged

docs: PR 템플릿 섹션별 작성 기준 명시#71
mingdodev merged 3 commits into
mainfrom
docs/pr-template-reviewer-notes

Conversation

@mingdodev

@mingdodev mingdodev commented Aug 30, 2026

Copy link
Copy Markdown
Member

Related Issue

  • 없음 (팀 규칙 문서 변경)

Why

지금 템플릿은 섹션 이름과 한 줄 주석뿐이라, 무엇을 담고 무엇을 담지 않는지가 사람마다 갈립니다. 특히 두 가지가 반복됩니다.

  • 리뷰어에게 묻고 싶은 것을 적을 자리가 없어 본문 곳곳이나 PR 올린 뒤 댓글로 흩어집니다
  • Prompt Log에 프롬프트 원문이 그대로 들어옵니다

What

.github/PULL_REQUEST_TEMPLATE.md를 섹션별 작성 기준이 적힌 판으로 교체했습니다.

  • 각 섹션에 필수/옵션과 "무엇을 쓰고 무엇을 쓰지 않는지"를 주석으로 명시했습니다. What은 파일 나열이 아니라 "무엇이 가능해졌나", How는 diff를 순서대로 읽어 파악되는 구현이면 생략이고, Why·What·How에는 좋은 예/나쁜 예를 붙였습니다
  • Notes for Reviewer 신설(옵션) — 봐줬으면 하는 파일·로직, 의견을 듣고 싶은 부분, 검증한 것과 못 한 것(CI가 보여주지 못하는 범위), 범위 밖으로 남긴 것, 로컬 재현 사전 조건
  • Prompt Log — 필수를 유지하되 작성 주체를 첫 줄에 명시했습니다. 에이전트가 받은 지시를 기반으로 초안을 쓰고 개발자가 확인해 고칩니다. 프롬프트 원문이 아니라 의도와 방향, 개발자의 선택을 적고, 한 줄에 판단 하나씩 개조식으로 누가(개발자/에이전트) 무엇을 판단했는지가 드러나게 씁니다. 좋은 예도 그 형태의 불릿으로 바꿨습니다

Notes for Reviewer

  • 검증한 것: 템플릿 파일 변경뿐이라 빌드 영향이 없습니다. 못 한 것: 실제 PR 작성 화면에서 주석이 어떻게 접히는지는 이 PR이 머지된 뒤에야 확인됩니다 — 써보고 거슬리는 부분이 있으면 후속으로 다듬겠습니다
  • BRANCHING.md §4는 PR 규칙(셀프 리뷰·크기·리뷰 등급)만 다루고 템플릿 본문 구성은 언급하지 않아, 이번 변경으로 어긋나는 서술은 없습니다

Prompt Log

  • 문제 상황(리뷰 요청이 본문·댓글로 흩어짐, Prompt Log에 프롬프트 원문이 들어옴)과 템플릿 본문을 개발자가 전달, 에이전트가 레포에 반영
  • 에이전트가 Notes for Reviewer를 필수로 올리고 Prompt Log 주석까지 고쳐온 것을, 매 PR에 없음을 적게 하는 건 과하고 Prompt Log는 원래 문구가 의도한 바라 되돌림
  • 개발자가 Notes for Reviewer에 검증한 것과 못 한 것 한 줄 추가
  • Prompt Log가 문단으로 쓰이는 원인이 서술형 예시 하나뿐인 주석이라고 보고, 작성 주체 명시 + 개조식 지시 + 예시 교체로 개발자가 확정

@mingdodev mingdodev changed the title docs: PR 템플릿 개편 — 리뷰 요청은 Notes for Reviewer로, Prompt Log 작성 주체 명시 docs: PR 템플릿 섹션별 작성 기준 명시 Aug 30, 2026

@wnsvy607 wnsvy607 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BRANCHING §4와 대조했는데 어긋나는 서술 없다는 본문 주장이 사실이고(§4는 셀프 리뷰·크기·등급·squash만 다룸), Notes for Reviewer 신설은 #70·#74 본문이 이미 실효를 보여주고 있네요. 그대로 머지해도 됩니다.

[q] Prompt Log가 [필수]인데 주석이 에이전트 사용을 전제합니다("에이전트가 받은 지시를 기반으로…"). 에이전트 없이 수기로 만든 PR에서는 빈 섹션/삭제/없음 중 뭐가 맞는지 한 줄 있으면 좋겠습니다. "매 PR 없음 강제는 과하다"고 되돌리신 이력을 봤으니, 의도된 공백이면 그대로 두셔도 됩니다.

@mingdodev

Copy link
Copy Markdown
Member Author

[q] Prompt Log가 [필수]인데 주석이 에이전트 사용을 전제합니다("에이전트가 받은 지시를 기반으로…"). 에이전트 없이 수기로 만든 PR에서는 빈 섹션/삭제/없음 중 뭐가 맞는지 한 줄 있으면 좋겠습니다. "매 PR 없음 강제는 과하다"고 되돌리신 이력을 봤으니, 의도된 공백이면 그대로 두셔도 됩니다.

의도된 공백은 아니고, 저희 팀 작업 방식에 따르면 에이전트를 사용하지 않는 경우는 없을 것이라 판단했습니다. 옵션으로 둘 경우 에이전트를 사용했음에도 그 작업 흐름과 개발자의 의도를 기록하지 못할 여지가 있어 필수로 두었습니다.

리뷰 감사합니다. 머지하겠습니당 ~~

@mingdodev
mingdodev merged commit 0e0adf8 into main Sep 1, 2026
2 checks passed
@mingdodev
mingdodev deleted the docs/pr-template-reviewer-notes branch September 1, 2026 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants