writing-pull-requests
Use when opening a pull request or writing a PR description in this repository
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
メニュー
Use when opening a pull request or writing a PR description in this repository
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
Use when adding, changing, or reviewing HTTP API controllers, request and response DTOs, ApiResponse payloads, JSON field names, or response nesting in this repository
Use when adding, moving, or renaming code in this repository, or deciding which module and package something belongs in
Use when writing a commit message or naming a branch in this repository
SOC 職業分類に基づく
| name | writing-pull-requests |
| description | Use when opening a pull request or writing a PR description in this repository |
PR 본문은 diff에 있는 사실만 담는다.
제목은 커밋 제목과 같은 [TYPE] 한국어 요약 형식이고, base는 develop이다. 형식 상세는 writing-commits를 쓴다.
.github/PULL_REQUEST_TEMPLATE.md의 섹션을 그대로 채운다.
<!-- ... -->)은 지운다. 내용을 HTML 주석 안에 쓰면 렌더링되지 않아 빈 섹션이 된다.Closes #N, 없으면 비운다직접 실행해서 결과를 본 항목만 [x]. 나머지는 [ ]로 남기고, 필요하면 Notes에 이유를 한 줄 쓴다.
셀프 리뷰와 불필요한 코드와 로그를 제거했습니다는 diff를 끝까지 읽었으면 체크한다 — 실행이 필요한 항목이 아니다.
| 넘어가려는 생각 | 사실 |
|---|---|
| "이 정도면 로컬에서 돌려봤을 것이다" | 내가 실행한 명령이 없으면 체크하지 않는다 |
| "조건부 항목이니 해당 없으면 체크해도 된다" | 해당 없음은 [ ]다 |
Red flags — 멈추고 다시 쓴다:
[x]본문은 파일에 쓰고 넘긴다.
gh pr create --base develop --title "[TYPE] 요약" --body-file pr-body.md
--body에 긴 마크다운을 인라인으로 넣으면 셸 이스케이프에서 깨진다.