| name | write-pr-description |
| description | 이 저장소에서 브랜치 변경 내역을 바탕으로 프로젝트 PR 본문 형식에 맞춰 요약, 상세 작업 내용, 참고사항을 작성할 때 사용한다. |
Write PR Description
루트 AGENTS.md 규칙을 전제로 사용한다.
목적
- 현재 브랜치의 작업 범위를 확인한다.
- PR 제목/본문에 들어갈 핵심 변경, 세부 작업, 검증 내용을 정리한다.
- 프로젝트에서 선호하는 PR 본문 형식을 일관되게 만든다.
작업 순서
git status --short로 작업 트리가 깨끗한지 확인한다.
git branch --show-current로 브랜치를 확인한다.
git log --oneline --decorate -5 또는 기준 브랜치와의 diff로 브랜치 커밋을 확인한다.
- 필요하면
git show --stat 또는 git diff --stat으로 변경 파일과 의도를 묶는다.
- 작업 내용을 2~4개의 큰 항목으로 그룹화한다.
- 실행한 테스트와 실패/미실행 사유를 참고사항에 적는다.
출력 형식
사용자가 다른 형식을 주지 않으면 아래 형식을 사용한다.
## 📄 PR 요약
> {한 문장 요약}
## ✍🏻 PR 상세
1. {작업 내용1}
- {세부 작업 내용1}
- {세부 작업 내용2}
2. {작업 내용2}
- {세부 작업 내용1}
- {세부 작업 내용2}
👀 참고사항
- {테스트 결과 또는 리뷰어가 알아야 할 내용}
작성 규칙
- PR 상세의 1차 항목은 의도 중심으로 작성한다.
- 세부 항목은 파일 목록보다 동작 변화, 정책 결정, 테스트 변경을 우선한다.
- 검증 결과는 참고사항에 적는다.
- 테스트를 실행하지 못했으면 이유를 정확히 적는다.
- Notion, Swagger, API 명세처럼 코드 외부 계약을 수정했다면 참고사항에 포함한다.
- 작업 트리에 커밋되지 않은 변경이 남아 있으면 PR 범위 포함 여부를 명확히 구분한다.