Commit message convention

다음의 규칙들을 지켜가며 commit을 하자.

• 제목의 형식

  • 내용은 영어로, 간결하게, 문법에 맞게
  • 50자를 넘기지 말자
  • 끝에 마침표 찍지 말자
  • [create]
  • [update]
  • [fix]
  • [delete]
  • [package]

• 제목과 본문의 관계

  • 둘 사이에 빈 행을 추가하자
  • 본문은 72자 단위로 개행하자

제목의 형식

기본적인 구조는 다음과 같다.

[category] Contents

주의해야 할 점은

• 내용은 영어로, 간결하게, 문법에 맞게 - 진행하는 프로젝트가 언제 어떻게 될지 모르기에..
  
• 50자를 넘기지 말자 - 가독성이 떨어짐
  
• 끝에 마침표 찍지 말자 - 찍을 이유가 없음
  

구조의 [category]에 들어가는 형식을 살펴보도록 하자.

create

1. Class등의 무언가 의미있는 것을 만든 경우
2. build.gradle이나 applicaiton properties와 같은 설정파일을 만든 경우

[create] BoardController class
[create] application properties setting

update

1. feature: 기능, 내용을 업데이트한 경우

[update feature] UserController signup response
[update feature] gradle lib add for setting jpa and database

fix

1. feature: 기능, 내용을 수정한 경우

[fix feature] CommentController post method

delete

1. 무엇인가 지울 경우

[delete] test class not used

package

1. 사소한 여러부분을 나누기 뭐해 동시에 commit할 경우 (비권장)

[package] tiny fixes of Si class, Gong class

제목과 본문의 관계

50자 안으로 요약하여 설명할 수 있는 내용이면 본문을 작성할 필요는 없다.
하지만 그것이 불가능하다면 아래의 규칙에 따라 본문을 작성하자.

둘 사이에 빈 행을 추가하자

이렇게 하면, 첫 번째 행을 제목과 같이 처리하게 되어 Git상에서 유용히 사용 가능하다.
아래 내용 중 첫 번째는 commit message의 예시이고, 두 번째는 git 명령어로 확인하는 방법이다.

[delete] test class not used

this class is too SI-GONG, so there is a threat to fall into it.

참고로, 옵션 중 --decorate는 브랜치나 태그같은 references의 위치를 확인 할 수 있고,
--graph는 commit history를 텍스트 그래픽으로 확인할 수 있다.

// 본문까지 확인
$ git log --decorate --graph

// 제목만 확인
$ git log --oneline --decorate --graph

본문은 72자 단위로 개행하자

Git은 전체 80자의 가로 공간을 가지는데, 자동 개행 기능이 없다.
따라서 여유를 가지고 72자를 입력 했다면 손수 개행해 주도록 하자.