| name | pr-create |
| description | 이 저장소의 실제 diff와 문서를 바탕으로 GitHub PR 제목/본문을 한국어로 작성하거나 업데이트한다. PR 생성, PR 제목/본문 수정, 엄격한 톤/형식 규칙에 맞춘 PR 본문 재작성 요청이 있을 때 사용한다. |
PR 생성
개요
실제 변경 내용을 반영한 PR 제목과 본문을 작성하거나 업데이트한다. 리뷰어가
What과 Why를 빠르게 이해할 수 있도록 의도 중심으로 정리한다. 사용자가 지정한
톤과 형식 규칙을 지키고 gh로 반영한다.
진행 절차
-
맥락 수집 git status를 확인하고 main 또는 지정된 base 브랜치와 diff를
확인한다. 관련 spec/progress/tasks/findings 문서를 연다. PR이 있으면
gh pr view로 현재 제목/본문을 읽는다. 이 단계에서 변경 사실과 변경 이유를
구분해 메모한다.
-
제목 작성 한국어 현재형으로 기능 단위를 드러내게 쓴다. 무엇이 바뀌는지와
목적이 바로 보이게 한다. 사용자가 요청하지 않은 접두사나 태그는 쓰지 않는다.
가능하면 50자 이내로 간결하게 쓴다.
-
본문 작성 존댓말과 현재형을 유지한다. 문장 단위로 줄바꿈하고 문단은 빈 줄로
구분한다. 사용자가 요구하지 않으면 제목이나 불릿을 쓰지 않는다. 각 문단에서
What과 Why가 함께 보이도록 구성한다.
문단 구성: 행동 문장으로 시작한다. 자연스러운 이유 문장을 뒤에 둔다. 이유 어미는
반복하지 않는다. ~시 표현은 피하고 ~할 때, ~하면을 쓴다. 요청이 없으면
의도, 리뷰 포인트 같은 표현은 쓰지 않는다. 배경과 목표를 자연스럽게 드러내
리뷰어가 맥락을 추측하지 않도록 한다.
이유 어미 예시: 위함입니다. 필요합니다. 하려는 선택입니다. 목적입니다.
해야 합니다.
-
PR 반영 PR이 있으면
gh api -X PATCH repos/<owner>/<repo>/pulls/<number> -f title=... -f body=...로
수정한다. PR이 없으면 base/head를 확인한 뒤
gh pr create --title ... --body ...로 생성한다. 적용 전에 요약이 실제
diff와 충돌하지 않는지 대조한다.
-
확인 적용된 제목/본문을 1~2줄로 알린다. 원하면 다른 톤이나 길이의 대안을
제시한다. 리뷰어 관점에서 보완할 맥락이 있는지 한 문장으로 제안한다.
품질 점검
- 제목과 본문이 실제 diff와 일치한다.
- 존댓말이 일관된다.
- 문장 단위 줄바꿈과 문단 구분이 지켜진다.
- 요청이 없으면 제목/불릿을 사용하지 않는다.
- 본문은 과거형을 쓰지 않는다.
- 이유 문장 어미가 반복되지 않는다.
- 각 문단에 What과 Why가 함께 드러난다.
