Git - commit message 작성법

commit 메세지 작성은 git을 사용하는 이유로 연결된다.

commit 메세지는 자신이 작업한 결과물이 무엇인지 한눈에 볼 수 있도록 하는 매우 중요한 단서이다.

 

지금 까지 내가 작성한 commit 메시지를 보자, 혼자 만든 결과물에 대한 commit 메세지인 만큼

아주 개판이다.

이 커밋 메세지만 보고서는 내가 어떤 기능을 왜 만들었는지 바로 들어오지 않는다.

그저 파일이 추가되었다는 메세지정도만 보이고 어느때는 create, complete, made등 단어 사용에 대한

기준이 명확하지 않다. 즉, 명시적이지 않은 메세지 때문에 만약 이와 같은 작업을 같이 하는 동료들에게

이러한 메세지는 그저 파일들의 추가만 명시할 뿐이다. 

 

아주 유명한 commit message 작성법이다.

chris.beams.io/posts/git-commit/

How to Write a Git Commit Message

여기서 말하고자 하는 바를 압축시켜보자

 

• 제목과 본문을 한 줄 띄워 분리하기
• 제목은 영문 기준 50자 이내로
• 제목 첫글자를 대문자로
• 제목 끝에 . 금지
• 제목은 명령조로
• 본문은 영문 기준 72자마다 줄 바꾸기
• 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기 

Commit 메세지의 제목을 시작하는 단어로서 쓰이는 명령어

• FIX - 보통 올바르지 않은 동작을 고친 경우에 사용합니다.
• ADD - 코드나 테스트, 예제, 문서 등의 추가가 있을 때 사용합니다
  
• REMOVE - 코드의 삭제가 있을 때 사용
• REFACTOR - 전면 수정이 있을 때 사용합니다.
• UPDATE - 원래도 정상적으로 동작하고 있었지만, 수정, 추가, 보완을 한다는 개념입니다. 코드보다는 주로 문서나리소스, 라이브러리등에 사용합니다
• IMPROVE - 향상이 있을 때 사용합니다. 호환성, 테스트 커버리지, 성능, 검증 기능, 접근성 등 다양한 것들이 목적
• MAKE - 주로 기존 동작의 변경을 명시합니다.
  
• REVISE - 문서의 개정이 있을 때 주로 사용합니다.
  
• CORRECT - 주로 문법의 오류나 타입의 변경, 이름 변경 등에 사용합니다.
  
• MOVE - 코드의 이동이 있을 때 사용합니다.
  
• RENAME - 이름 변경이 있을 때 사용합니다.
  
• VERIFY - 검증 코드를 넣을 때 주로 사용합니다.
  
• SET - 변수 값을 변경하는 등의 작은 수정에 주로 사용합니다.

또 git 이모지라는 것도 있다. commit메세지에 이모지를 넣을수도 있다.

이러한 이모지로 커밋구분을 하는 것이다.

 

www.webfx.com/tools/emoji-cheat-sheet/

Emoji cheat sheet for GitHub, Basecamp and other services

위 사이트에서 이모지 들을 가져와서 넣으며 커밋구분을 할 수 있다.