Git - Commit Message Convention

2020년 새해와 함께(라고했지만 하루 뒤인 2020. 01. 02) 시작한 온라인 스터디에서는 자바 컨벤션과 구조를 생각하며 코드를 짜고있다. 

Convention 사전 뜻으로 규약인데, 이 규약을 지킨다는게 쉬운일이 아니라는것을... 아마 시도해본 사람들은 다 알것이다. (여담이지만 코드 컨벤션 3번정도 읽는데 하루가 다 갔던...) 하지만 Git에도 Message Convention이 있다. 어디까지나 컨벤션은 기능적인 문제가 아닌, (다른 개발자들과의) 소통의 관점에 초점을 둔 것이라 추측한다. 코드를 짤 때, 클린 코딩, 가독성 측면 이라는 말을 많이 들어봤을 것이다.(코린이인 나조차도 그 용어만큼은 정말 익숙하다) 클린 코딩과는 관계가 없지만, 이번에 포스팅하려는 Commit Message Convention이 협업하는 개발자들끼리의 약속이라고 생각한다. 

나의 이전 commit 메세지를 보자 

 

github 툴이 익숙치 않은 분들에게는 뭔가 그럴싸해 보일 수도 있지만 github 좀 써보신분들이 보기에는 거슬릴 수도 있을 것이라 생각한다. 내용을 잘보면 리팩토링의 경우 [REFACTOR] 을 쓰겠다고 생각했는데, 다른 프로젝트하다가 다시 돌아와서 진행하다보니(간략히 말해 일괄된 규칙이 없다보니) 리팩토링을 실행하는데 [UPDATE]를 적어놓는다거나, README.md 수정의 경우 [ ] 태그 없이 적을려고 했는데, 중간에 [UPDATE]를 또 쓴 ... 실수를 반복하였다. (더 민망한건 REFACTOR --> REPACTOR로 쓴 것... 전 뼛속까지 한국인입니다. 하지만 한국말도 잘하지는 못합니다.) 

일관되지 못한 커밋 메시지에 답답함이 느껴졌고, github 툴을 1도 못쓰던 시절에 우연히 지나쳤던 commit관련 convention을 본 것 같다는 생각이 문득 들어서, 찾아보니 

참고: https://doublesprogramming.tistory.com/256

Git - 커밋 메시지 컨벤션

(Lucky!! 나의 잔기억력에 박수를 친다)

결론은 나와 협업을 해야하는 미래의 동료들을 괴롭게 하지 않기 위해서, 지금부터 소통왕이 되어보기로 한다.

 

Commit Message Convention

 

커밋 메시지를 작성할 때에는 원칙을 정해서 일관되게 작성해야 한다.

 

1. Commit Message Structure

---

기본적인 커밋 메시지는 아래의 구조로 구성한다.

type:  subject body footer

 

2. Commit Type

---

• feat : 새로운 기능 추가

• fix : 버그 수정

• docs : 문서 수정

• style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우

• refactor : 코드 리팩토링

• test : 테스트 코드, 리팩토링 테스트 코드 추가

• chore : 빌드 업무 수정, 패키지 매니저 수정

 

3. Subject

---

• 제목은 50자를 넘기지 않고, 대문자로 작성하고 마침표를 붙이지 않는다.

• 과거 시제를 사용하지 않고 명령어로 작성한다.

  ex) "Fixed" -> "Fix" ,  "Added" -> "Add" 

 

4. Body

---

• 선택사항이기 때문에 모든 커밋에 본문내용을 작성할 필요는 없다.

• 부연설명이 필요하거나 커밋의 이유를 설명할 경우 작성한다.

• 72자를 넘기지 않고 제목과 구분되기 위해 한칸을 띄워 작성한다.

 

5. footer

---

• 선택사항이기 때문에 모든 커밋에 꼬리말을 작성할 필요는 없다.

• issue tracker id를 작성할 때 사용한다.

 

6. Example

---

 

7. Reference

---

https://sujinlee.me/professional-github/

깃허브(GitHub)로 취업하기

https://udacity.github.io/git-styleguide/

Udacity Nanodegree Style Guide