[Git] 커밋 메시지가 50자 인지 어떻게 알지? 커밋 템플릿!

안녕하세요. 애플사이다입니다.

Git commit message style guide에 대해 읽다가 "subject line (commit title)은 50자 이내, body는 72자 이내"라는 규칙을 배웠어요.

*Karma Style을 흔히 사용합니다.

 

그런데 터미널에서 작성한 commit message가 몇 자 인지 매번 직접 세어봐야 할까요?

✅ "커밋 템플릿"을 통해 쉽게 확인이 가능합니다. 

 

커밋 템플릿 설정 방법을 간단히 알아보겠습니다.

---

커밋 템플릿, 적용하면 어떻게 되나?

터미널에서 git commit을 입력하면, 템플릿 내용을 확인하면서 커밋 메시지를 작성할 수 있다.

글자 수도 확인하고, commit type 등 자주 쓰는 키워드도 참고할 수 있다.

터미널에서 "git commit"을 입력하면 보이는 창

• 커밋 메시지를 입력할 때는 i (insert)를 누른 후에 작성하면 된다.
• #로 시작하는 줄은 텍스트가 무시되어 커밋 메시지에 포함되지 않는다.
• 커밋 메시지의 title을 맨 위에 입력하고, 줄바꿈을 2번 한 뒤에 body를 입력한다.
• 작성이 완료되면 esc키 > :wq (write and quit)으로 저장하고 vim을 종료한다.

커밋 템플릿 적용하기

이미 잘 만들어진 커밋 템플릿을 골라서 수정하여 쓰면 된다.

✅ 아래 블로그의 커밋 템플릿 내용을 이렇게 수정해서 사용하면 좋다.

# <타입>: <제목>

##### 제목은 최대 50 글자까지만 입력 ############## -> |


# 본문은 위에 작성
######## 본문은 한 줄에 최대 72 글자까지만 입력 ########################### -> |

# 꼬릿말은 아래에 작성: ex) #이슈 번호

# --- COMMIT END ---
# <타입> 리스트
#   feat    : 기능 추가
#   fix     : 버그 수정
#   refactor: 리팩토링 (함수 분리/이름수정 등 실행 결과의 변경 없이 코드 구조를 재조정)
#   style   : 스타일 (코드 컨벤션 수정: 비즈니스 로직에 변경 없음)
#   docs    : 문서 (README 등 문서 추가/수정/삭제)
#   test    : 테스트 (테스트 코드 추가/수정/삭제: 비즈니스 로직에 변경 없음)
#   chore   : 기타 사소한 변경사항 (빌드 스크립트 수정 등)
# ------------------
#     제목 첫 글자를 대문자로
#     제목은 명령문으로
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------

커밋 템플릿을 적용하는 방법은 아래 블로그에 잘 나와있다.

https://junwoo45.github.io/2020-02-06-commit_template/

 

 

🍎 포스트가 도움이 되었다면, 공감🤍 / 구독🍹 / 공유🔗 / 댓글✏️ 로 응원해주세요. 감사합니다.