Skip to content

PR 템플릿: 제목 칸에 작성 안내 추가 (브랜치명 복붙 방지) - #2

Open
moonjiho-bigtablet wants to merge 1 commit into
mainfrom
docs/pr-template-title-guide
Open

PR 템플릿: 제목 칸에 작성 안내 추가 (브랜치명 복붙 방지)#2
moonjiho-bigtablet wants to merge 1 commit into
mainfrom
docs/pr-template-title-guide

Conversation

@moonjiho-bigtablet

@moonjiho-bigtablet moonjiho-bigtablet commented Aug 12, 2026

Copy link
Copy Markdown

제목

PR 템플릿 제목 칸에 작성 안내를 넣어 브랜치명 복붙을 막는다

작업한 내용

  • 제목제목제목 플레이스홀더 → 작성 안내 주석(예시 포함)
  • 작업한 내용 · 전달할 추가 이슈 칸에도 짧은 안내
  • 예시 문구를 지우지 않고 제출해도 본문이 지저분해지지 않도록 HTML 주석으로 (GitHub 에서 렌더 안 됨)

## 제목 에 브랜치명을 그대로 적는 관행 때문에 업무 보드·업무일지에 뜨는 글자가 feat/stt-search, fix/auth 였다. PM·대표가 무슨 작업인지 읽을 수 없다.

실측: bigtablet-insight-app 최근 머지 PR 15건 중 13건이 브랜치명 그대로.

기존 플레이스홀더가 제목제목제목 이라 무엇을 쓰라는 건지 알려주지 않았다.

레벨2 헤딩은 건드리지 않았다 (중요)

## 제목 · ## 작업한 내용 · ## 전달할 추가 이슈 세 헤딩은 그대로다. 인트라넷이 이 이름으로 PR 본문을 읽어 업무 제목 · 체크리스트 · 업무일지 요약을 만든다. 헤딩을 바꾸면 그게 조용히 멈춘다.

앞으로 헤딩을 바꿔야 하면 인트라넷 /admin/githubPR 본문 섹션 이름 설정도 함께 바꾸면 된다(코드 배포 불필요하도록 방금 설정화했다 — intranet #5039).

검증

신규 템플릿을 인트라넷 파서에 그대로 태워 확인했다:

상황 결과
안내를 안 지우고 그대로 제출 제목은 PR 제목으로 폴백, 체크리스트 0개, 본문에 주석 안 남음 — 지금과 동일하게 안전
정상 작성 제목 미팅 녹음에서 원하는 대목을 검색하는 기능 추가, 체크리스트 2개 정상

전달할 추가 이슈

  • 이 템플릿은 사람이 GitHub UI 로 여는 PR 에만 적용된다. gh pr create --body 로 만드는 PR(워커·자동화)에는 적용되지 않는다
  • 커밋 메시지 영문 규칙(COMMIT_GUIDELINE.ko.md)은 이번 변경과 무관하며 손대지 않았다

Summary by CodeRabbit

  • 문서화
    • 풀 리퀘스트 템플릿을 구조화된 제목, 작업 내용, 추가 이슈 섹션으로 개선했습니다.
    • 제목 작성 안내와 예시를 추가했습니다.
    • 작업 내용 및 추가 이슈 작성을 위한 주석과 기본 체크 항목을 제공합니다.

`## 제목` 에 브랜치명을 그대로 적는 관행 때문에 업무 보드·업무일지에 뜨는 글자가
`feat/stt-search` 였다. 개발을 모르는 사람이 읽을 수 없다.
실측: insight-app 최근 PR 15건 중 13건이 브랜치명 그대로.

플레이스홀더(`제목제목제목`)를 HTML 주석 안내로 바꾼다. 주석은 GitHub 에서
렌더되지 않아 안 지우고 제출해도 본문이 지저분해지지 않는다.

주의: 레벨2 헤딩 3개(`## 제목` `## 작업한 내용` `## 전달할 추가 이슈`)는 그대로 둔다 —
인트라넷이 이 이름으로 PR 을 읽어 업무 제목·체크리스트를 만든다.
헤딩을 바꿔야 하면 인트라넷 /admin/github 의 섹션 이름 설정도 함께 바꿔야 한다.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: eb7eb3da-ddc7-4866-ba9b-36863efbfe97

📥 Commits

Reviewing files that changed from the base of the PR and between 517081a and ce31306.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md

📝 Walkthrough

Walkthrough

PR 템플릿을 구조화된 제목, 작업 내용, 추가 이슈 섹션으로 변경했습니다. 제목 작성 지침과 예시를 추가하고, 작업 체크리스트와 추가 이슈 입력란을 제공합니다.

Changes

PR 템플릿 변경

Layer / File(s) Summary
템플릿 구조 및 작성 항목
.github/PULL_REQUEST_TEMPLATE.md
제목에 한 줄 요약 지침과 예시를 추가했습니다. 작업 내용에는 빈 체크박스 두 개를 제공합니다. 추가 이슈에는 기본 빈 항목을 제공합니다. 브랜치명 사용 금지와 비개발자 대상 작성 지침을 추가했습니다.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

깡충 토끼가 템플릿을 펼쳐요
제목은 짧고 또렷하게 써요
체크 두 칸이 나란히 웃고
추가 이슈도 자리를 잡아요
새로운 PR이 가볍게 달려요 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 제목은 PR 템플릿의 제목 작성 안내 추가와 브랜치명 복사 방지라는 주요 변경 사항을 명확하게 설명합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/pr-template-title-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant