Repository navigation
Issue & PR Format
KKH edited this page Sep 24, 2026
·
2 revisions
- 해당 Repository의 Issue & PR Format 및 commit 메시지의 규칙을 정의합니다.
- 모든 Branch는 하나 이상의 Issue를 할당받아야 합니다.
- 모든 Issue의 제목은 동사로 시작하며,
[prefix] title의 형식을 사용합니다. -
prefix의 규칙은 아래 표와 같습니다.
prefix |
사용 방식 |
|---|---|
Feat |
새로운 기능 추가 |
Fix |
버그 수정 등 잘못된 동작 수정 |
Add |
새로운 기능을 추가하지 않으며, 새로운 코드를 추가 |
Refactor |
코드 리팩토링 |
Docs |
문서 정리 |
Misc |
단순한 설정 파일 변경 및 주석 정리 작업 등 기능 외적인 변경 수요 |
해당 Repository에 생성되는 모든 Issue의 형식은 아래 구조와 같습니다.
- Background: 해당 Issue가 발생한 배경
- Requirement: 해당 Issue를 해결하기 위해 필요한 기능 또는 구현 상세
- Test Plan: 실제 테스트 시 검증할 항목 열거
- 모든 PR 제목은
#issue number: title의 형식입니다. 다만, Issue의 prefix가Misc인 경우,Misc: title형식을 사용합니다. - 또한 PR 내용의 양식은 아래 구조와 같습니다.
- Summary: 변경사항 요약
- Changes: 수정사항 상세
- Test Result: 해당 Branch의 모든 Issue 내의 모든 Test Plan 통과 여부에 대한 체크리스트
- Commit Message는
prefix: suffix의 형태로 작성합니다. -
prefix의 규칙은 아래 표와 같습니다.
prefix |
사용 방식 |
|---|---|
feat |
새로운 기능 추가 |
fix |
버그 수정 등 잘못된 동작 수정 |
add |
새로운 기능을 추가하지 않으며, 새로운 코드를 추가 |
refactor |
코드 리팩토링 |
docs |
문서 정리 |
etc |
타 브랜치와의 동기화 등 기능 외적인 수정사항 |