| Type 키워드 | 사용 시점 |
|---|---|
| Feat | 새로운 기능 추가 |
| Fix | 버그 수정 |
| Docs | 문서 수정 |
| Style | 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)기능 수정이 없는 경우 |
| Test | 테스트 코드, 리팩토링 테스트 코드 추가 |
| Refactor | 코드 리팩토링 |
| CI | CI 설정 파일 수정 |
| CD | CD 설정 파일 수정 |
| Perf | 성능 개선 |
| Chore | 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등) |
| Rename | 파일 혹은 폴더명을 수정만 한 경우 |
| Remove | 파일을 삭제만 한 경우 |
| Add | 코드나 테스트, 예저 문서등의 추가 생성이 있는 경우 |
| Improve | 향상이 있는 경우, 호환성, 검증 기능, 접근성 등이 될 수 있음 |
| Move | 코드의 이동이 있는 경우 |
| Updated | 계정이나 버전 업데이트가 있을 때 사용, 주로 코드보다는 문서, 리소스, 라이브러리 등에 사용 |
| Comment | 필요한 주석 추가 및 변경 |
PR 제목 → Fix #이슈번호 - (내용)
PR 제목 예시 → Chore #이슈번호 - 회원가입 API 추가
## PR 체크리스트
아래 항목을 확인해 주세요:
- [ ] 커밋 메시지가 우리의 가이드라인을 따르고 있는지 확인하세요
- [ ] 변경 사항에 대한 테스트가 추가되었는지 확인하세요 (버그 수정 / 기능 추가)
- [ ] 문서가 추가되거나 업데이트되었는지 확인하세요 (버그 수정 / 기능 추가)
## PR 유형
이 PR은 어떤 종류의 변경을 가져오나요?
<!-- 이 PR에 해당하는 것을 "x"로 표시하세요. -->
- [ ] 버그 수정
- [ ] 새로운 기능 추가
- [ ] 코드 스타일 업데이트 (서식, 로컬 변수)
- [ ] 리팩터링 (기능 변경 없음, API 변경 없음)
- [ ] 빌드 관련 변경
- [ ] CI 관련 변경
- [ ] 문서 내용 변경
- [ ] 애플리케이션 / 인프라 변경
- [ ] 기타... 설명:
## 현재 동작은 무엇인가요?
<!-- 수정 중인 현재 동작을 설명하거나 관련된 이슈에 링크하세요. -->
이슈 번호: N/A
## 새로운 동작은 무엇인가요?
## 이 PR은 호환성 변경을 도입하나요?
- [ ] 예
- [ ] 아니요
<!-- 이 PR에 호환성 변경이 포함되어 있다면, 기존 응용 프로그램에 대한 영향과 마이그레이션 경로를 아래에 설명해 주세요. -->
## 기타 정보
이슈 제목 예시→ 유저 API 작성
## 이슈 내용
> 이슈 내용 작성
<br>
## 작업 사항
- [ ] 해당 이슈의 작업사항
<br>
## 관련 이슈
- #이슈 번호
<br>
## 기타사항
<br>
---
name: Bug template
about: 버그 발생 시 사용하는 템플릿입니다
title: "버그 리포트"
labels: "bug"
assignees:
---
## 버그에 대한 설명
버그가 무엇인지 명확하고 간결하게 설명합니다.
## 재현 방법
어떤 식으로 발생했는지 순서대로 작성해주세요:
1. 어디를 가서 '....'
2. 어떤 행동을 했더니 '...'
3. 에러가 나왔다 ' ... '
## 예상 동작
발생할 것으로 예상한 사항에 대한 명확하고 간결한 설명.
## 스크린샷
해당하는 경우 스크린샷을 추가하여 문제를 설명.
## 추가 내용
여기에 문제에 대한 다른 내용을 추가합니다.