작성자 : 정혜영

📄 문서 개요

컨벤션이 정해져 있지 않은 커밋 메시지와 브랜치명은 가독성이 매우 떨어집니다. 특히 여러 사람과 개발을 같이 할 때는 더욱 심각해지고, 코드를 유지보수 하기에도 어려워집니다. 협업하는 사람들 간의 스타일을 정해두면 커뮤니케이션이 명확해지고, 코드 변경 사항을 빠르게 파악할 수 있기에 해당 문서를 작성합니다.

📧 commit message convention

커밋 메시지 구조

제목, 본문, 꼬리말 세가지 파트로 나뉩니다.

제목 (필수)

type: do something

태그: 제목의 형태, :뒤에만 공백이 있습니다.

type	설명
feat	새로운 기능 추가
fix	버그 수정
modify	단순 수정
docs	문서 수정
style	코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
design	사용자 UI 디자인 변경 (CSS 등)
merge	중간저장을 위한 병합을 하는 경우
test	테스트 코드, 리팩토링 테스트 코드 추가
chore	빌드 업무 수정, 패키지 매니저 수정
refactor	코드 리팩토링
rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만 수행한 경우
remove	파일을 삭제하는 작업만 수행한 경우

• 제목은 최대 50자를 넘기지 않습니다.
• 마침표나 특수기호를 붙이지 않습니다.
• 영어로 작성 시 첫 글자는 대문자로 작성합니다.
• 간결하고 요점적으로 서술합니다.

본문 (선택)

• 한 줄당 72자 내로 작성합니다.
• 제목보다 상세하게 작성합니다.
• 어떻게 보다는 무엇을, 왜 변경했는지 작성합니다.

꼬리말(선택)

• #이슈번호 형식으로 작성합니다.
• 여러개의 이슈는 ,로 구분합니다.

issue tracker 유형은 다음 중 하나를 사용합니다.

유형	설명
Fixes	이슈 수정중 (아직 해결되지 않은 경우)
Resolves	이슈를 해결했을 때 사용
Ref	참고할 이슈가 있을 때 사용
Related to	해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

🌵 branch naming convention

안정성과 버전 관리 및 체계적인 운영이 가능하게끔 하기 위하여, 브랜치 전략은 Git Flow를 따릅니다.
Git Flow 참고 문서

모든 브랜치 명은 케밥케이스로 작성합니다.

type/kebab-case

ex) feature/login-form  
ex) fix/user-auth-error

참고 자료

• 커밋 컨벤션, Gitmoji 컨벤션 정리
• Git commit 컨벤션 개념 & 템플릿 설정
• git branch 네이밍 규칙
• Git branch & naming