[GitHub] 애자일(Agile)스럽게 팀프로젝트 준비하기3 - 커밋 컨벤션

커밋 컨벤션 적용 예시

Feat: "추가 로그인 함수"

로그인 API 개발

Resolves: #123
Ref: #456
Related to: #48, #45

=======================
improve : #OOOO - 작업 기능 추가

2022-xx-xx XX님의 요청으로 OO 작업 기능을 추가개발함
* OOOO 개발
* DB는 ~~ 참고
* 문서 ~ 참고
* ....

resolved : #OOOO
see also : #XXX, #YYY, #ZZZ​

---

# 제목

예시) Feat: #1 - 추가 get data api 함수

 

• 제목 영어는 첫글자 대문자
• 제목 한글은 명령어로 시작
• 제목 끝에 마침표 금지

 

 

[ 타입 태그 ] 

Feat : 새로운 기능을 추가할 경우(서비스의 기능이 추가되는 것이라면 모두 포함, 무구 수정도 포함)

Fix : 기능에는 수정사항이 없고 버그 수정

Design : UI 디자인 변경  

!HOTFIX: 급하게 치명적인 버그를 고쳐야하는 경우

Chore : 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore

Comment: 필요한 주석 추가 및 변경

Docs: 문서를 수정한 경우

Style : 코드 의미에 영향을 주지 않는 변경상항 ex) 세미콜론 누락, 코드 수정이 없는 경우

Refactor : 기능의 변화가 아닌 단순 코드 리팩터링 ex) 변수 이름 변경

Rename : 파일 혹은 폴더명을 수정 및 이동

Remove : 파일을 삭제

 

 

 

 

---

# 본문

예시) 2022-xx-xx XX님의 요청으로 로그인 기능 구현을 위해 로그인 요청을 보내는 abc 함수 작성

* OOOO 개발

* DB는 ~~ 참고

* 문서 ~ 참고

* ....

 

• 본문은 어떻게 변경했는지 보다 히스토리 파악을 위해 무엇을 / 왜 변경했는지 설명
• 수정 사항이 여러가지 일 때 *로 입력

 

 

 

---

# 꼬리말

예시)

Resolves: #123

Ref: #456

Related to: #48, #45

 

 

• 꼬리말은 "유형: #이슈 번호" 형식으로 사용
• 여러 개의 이슈 번호를 적을 때는 쉼표로 구분
• 이슈 트래커 유형
  • Fixes: 이슈 수정중 (아직 해결되지 않은 경우)   
  • Resolves: 이슈를 해결했을 때 사용   
  • Ref: 참고할 이슈가 있을 때 사용   
  • Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우) ex) Fixes: #45 Related to: #34, #23

 

 

 

 

Refence

🔗 https://greenzoo.tistory.com/36