[TIL] 좋은 커밋 메세지 작성하기

유현영·2020년 1월 9일
14

커밋 메시지 중요성

영어, 한글 번갈아 가면서 커밋 메시지를 작성하고 구분 단위 없이 무작성 커밋만 하다 보니 체계가 필요하다는 생각이 들었다. 처음부터 잘 되지는 않을 것 같지만 최대한 지키고 내 커밋 스타일을 만들도록 노력해야겠다.

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속

이하 약속은 커밋 메시지를 English로 작성하는 경우에 최적화되어 있습니다. 한글 커밋 메시지를 작성하는 경우에는 더 유연하게 적용하셔도 좋을 것 같네요.

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

출처 : HOW TO WRITE A GIT COMMIT MESSAGE

많이 쓰는 커밋 명령어

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

profile
오늘보다 더 나은 내일

0개의 댓글