프로젝트 내 커밋 메시지 관례를 정하여 협업 효율성을 향상합니다. 아래 정의된 사항은 권고사항으로 프로젝트 구성원이 좋은 커밋을 할 수 있도록 길잡이 해주는 역할을 함을 목적으로 합니다.

기본 지키기

커밋 메시지 관례에 대한 수많은 글을 보았는데, 결국 하나의 글이 원본이고 여기에 작성자의 생각이 보탠 글들입니다. 아래는 가장 기본적인 부분들만 리스트업 한 것입니다. (한글 번역본으로 이동합니다.)

1. 제목과 본문을 빈 행으로 분리한다
2. 제목 행을 50자로 제한한다
3. 제목 행 첫 글자는 대문자로 쓴다
4. 제목 행 끝에 마침표를 넣지 않는다
5. 제목 행에 명령문을 사용한다
6. 본문을 72자 단위로 개행한다
7. 어떻게 보다는 무엇과 왜를 설명한다

조금만 더...

• 커밋의 제목 행은 항상 영문으로 작성한다. 단, 본문은 한글 작성을 허용한다. 영어 본문 커밋 > 한글 본문 커밋 >>>>>>> 설명이 없는 커밋

• 자주 사용하는 명령문을 정하고 통일하려 노력한다.

  • Refactor, Update, Upgrade, Remove, Release, Polish, Add, Rename

  $ git clone [email protected]:spring-projects/spring-framework.git
  
  $ cd spring-framework
  // 전체 커밋 라인수
  $ git log --all | wc -l
    186871
  
  // Polish 가 들어간 OR 검색 라인수
  $ git log --all --grep='Polish' --grep="polish" | wc -l
    21489
  
  // And 검색
  $ git log --all --grep='add' --grep="method" --all-match
  

리베이스의 활용

이 부분은 저부터 조금 써보고 따로 가이드를 작성하도록 하겠습니다. 그 전에 다른 분들도 아래 글 읽어보고 할 준비를 갖춰주세요. 외부에 공개할 수 있는 깃로그를 만들기 위해서 필수적이라고 생각됩니다.

Git - Rebase하기

Git - 히스토리 단장하기

추후 고려 사항들

적용하면 좋지만 당장은 필요없거나 추후 적용 관례를 정리합니다.