숏컷 코드
md
Closes #10
Fixes owner/repo#20
Resolves https://github.com/owner/repo/issues/30
Duplicate of #42| keyword | 의미 |
|---|---|
close, closes, closed | 관련 이슈 종료 의도 |
fix, fixes, fixed | 버그 수정 완료 의도 |
resolve, resolves, resolved | 문제 해결 완료 의도 |
Duplicate of | 중복 이슈 표시 |
동작 기준
GitHub에서는 PR 설명이나 commit message에 closing keyword와 issue reference를 같이 쓰면, PR이 기본 branch에 merge될 때 연결된 이슈가 자동으로 닫힐 수 있습니다.
md
변경 사항:
- 로그인 실패 시 에러 메시지를 보정했습니다.
Fixes #128같은 저장소 이슈는 #128처럼 짧게 쓸 수 있고, 다른 저장소 이슈는 owner/repo#128처럼 전체 저장소를 포함해야 합니다. URL로 직접 참조하는 방식도 사용할 수 있지만, 팀 내부 문서에서는 짧은 저장소 참조가 읽기 쉽습니다.
Closing keyword는 단순 링크와 다릅니다. #128만 쓰면 참조 링크에 가깝고, Fixes #128처럼 keyword를 붙이면 병합 시 자동 종료 의미가 생깁니다.
선택 기준
| 상황 | 표현 |
|---|---|
| 같은 저장소 이슈 자동 종료 | Closes #123 |
| 다른 저장소 이슈 자동 종료 | Fixes owner/repo#123 |
| 문제 해결 완료를 강조 | Resolves #123 |
| 단순 참고만 필요 | keyword 없이 명시적 링크 |
| 중복 이슈 표시 | Duplicate of #123 |
| 외부 문서로 이동 가능 | 명시적 URL 링크 병행 |
자동 종료는 리뷰 흐름을 줄여 주지만, 의도가 잘못 들어가면 아직 끝나지 않은 이슈가 merge와 함께 닫힐 수 있습니다. PR 본문에서 관련 이슈와 닫을 이슈를 구분해 적는 습관이 필요합니다.
주의할 점
Closing keyword는 GitHub 서비스 동작에 의존합니다. GitHub 밖의 Markdown 렌더러에서는 일반 텍스트나 링크로만 보일 수 있으므로, 외부 릴리스 노트나 문서에는 이슈 상태를 별도로 설명하는 편이 안전합니다.
또 관련 이슈를 참고만 하는 경우에는 Fixes나 Closes를 쓰지 마세요. 자동 종료가 필요 없는 연결에는 Related to #123처럼 의도를 명확히 남기는 편이 좋습니다.
참고 링크
1 sources