깃 컨벤션

깃 컨벤션

💡 이 페이지는 깃 컨벤션에 대한 내용을 담고 있습니다. 아래의 컨벤션을 따르는 것은 개인의 판단이며 협업하는 사람들에게 작업 내용만 제대로 전해진다면 본인의 방법대로 해도 무방하다고 생각합니다.

다만 더 좋은 개발문화와 협업 프로세스를 만들기 위해 사용해보면 좋을 것 같습니다.

널리 쓰이는 Udacity Git Commit Message Style Guide를 따릅니다.

 

 

1. Commit 메시지 구조

기본 적인 커밋 메시지 구조는 제목,본문,꼬리말 세가지 파트로 나누고, 각 파트는 빈줄을 두어 구분한다.

type : subject

body 

footer

2. Commit Type (커밋 유형) -필수

타입은 태그와 제목으로 구성되고, 태그는 영어로 쓰되 첫 문자는 대문자로 한다.

태그 : 제목의 형태이며, :뒤에만 space가 있음에 유의한다.

• feat : 새로운 기능 추가
• fix : 버그 수정
• docs : 문서 수정
• style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• refactor : 코드 리펙토링
• test : 테스트 코드, 리펙토링 테스트 코드 추가
• chore : 빌드 업무 수정, 패키지 매니저 수정

3. Subject (커밋 제목) -필수

• 제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않는다.
• 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기한다.(과거 시제를 사용하지 않는다.)
• 제목은 개조식 구문으로 작성한다. --> 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미.

* Fixed --> Fix
* Added --> Add
* Modified --> Modify

4. Body (커밋 본문) -선택

본문은 다음의 규칙을 지킨다.

• 본문은 한 줄 당 72자 내로 작성한다.
• 본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
• 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.

5. footer (커밋 꼬릿말) -선택

꼬릿말은 다음의 규칙을 지킨다.

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

6. Commit 예시

Feat: "회원 가입 기능 구현"

SMS, 이메일 중복확인 API 개발

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

 

https://velog.io/@shin6403/Git-git-%EC%BB%A4%EB%B0%8B-%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0

Git | git 커밋 컨벤션 설정하기

 

 

https://rich-tiglon-29a.notion.site/6e8d225fd91f401f8f5f2babf75aa311

깃 컨벤션

 

아래 블로그에 보다 많은 commit type이 있다.

https://overcome-the-limits.tistory.com/6

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