협업을 위한 git 커밋컨벤션

22.03.31

프로젝트를 진행하면 할 수록 어떻게하면 협업을 더 잘할 수 있을까 고민하게 됐습니다.

앞으로 작성할 GIT Commit Message에 커밋 컨벤션을 적용하기로 했습니다.

 

 

 

 

 

커밋 메세지는 크게 제목, 본문, 꼬리말 세가지 파트로 나눕니다.

 

제목의 태그는 어떻게 적는가?

태그는 다음과 같은 종류로 구분됩니다. 태그 뒤에는 ": "를 붙여 제목과 구별할 수 있도록 합니다.

 

 

• type : 어떤 의도로 커밋했는지를 type에 명시합니다. 자세한 사항은 아래서 설명하겠습니다.
• subject : 최대 50글자가 넘지 않도록 하고 마침표는 찍지 않습니다. 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기합니다. 
• body : 긴 설명이 필요한 경우에 작성합니다. 어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성합니다. 최대 75자를 넘기지 않도록 합니다. 
• footer : issue tracker ID를 명시하고 싶은 경우에 작성합니다.

 

태그 이름	설명
Feat	새로운 기능을 추가할 경우
Fix	버그를 고친 경우
Design	CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor	프로덕션 코드 리팩토링
Comment	필요한 주석 추가 및 변경
Docs	문서를 수정한 경우
Test	테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore	빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove	파일을 삭제하는 작업만 수행한 경우

제목은 어떻게 적는가?

 

제목은 코드 변경 사항에 대한 짧은 요약을 나타냅니다. 제목은 다음의 규칙을 지킵니다.

 

1. 제목의 처음은 동사 원형으로 시작합니다.
2. 총 글자 수는 50자 이내로 작성합니다.
3. 마지막에 특수문자는 삽입하지 않습니다. 예) 마침표(.), 느낌표(!), 물음표(?)
4. 제목은 개조식 구문으로 작성합니다.

 

만약 영어로 작성하는 경우 다음의 규칙을 따릅니다. 

 

1. 첫 글자는 대문자로 작성합니다.
2. "Fix", "Add", "Change"의 명령어로 시작합니다.

 

한글로 제목을 작성하는 경우 다음의 규칙을 따릅니다.

 

1. "고침", "추가", "변경"의 명령어로 시작합니다.

 

예시)
Feat: "추가 get data api 함수"

 

 

 

앞으로 진행될 SendOwl project는 위처럼 commit할 예정입니다.

 

 

출처: https://overcome-the-limits.tistory.com/entry/협업-협업을-위한-기본적인-git-커밋컨벤션-설정하기

[협업] 협업을 위한 git 커밋컨벤션 설정하기