Git 커밋 메시지 50/72 규칙 소개

김해중·2020년 8월 5일
0

git

목록 보기
1/4

커밋 메시지를 작성하는 작성하는 서식? 규칙 중 50/72에 대해서 알아보겠습니다.

50/72?

요약

  • 첫줄은 제목을 입력한다.
  • 제목은 .을 표함하지 않음 명령조로 한다.
  • 제목은 영어 50자 이내로 작성한다.
  • 본문은 제목에서 한줄 더 내린 후 작성한다.
  • 본문은 72자가 넘어갈 경우 줄내림 한다.

예1)

줄: 내용
1: 커밋 메시지의 제목을 50자 이내로 작성합니다
2: (공백)
3: 상세 메시지를 입력합니다. 단 72자 이내로 작성합니다.
4: 3번 줄과 같은 형태를 유지합니다.

예2)

1: 상품 상세 저장 Entity의 이름을 변경한다
2:
3: SavedProductEntity는 이름과 목적이 서로 어쩌구의 이유로...
4: 어쩌구...해서 Entity의 이름을 StoredProductEntity로 변경한다.
5: 어쩌구...

주의

위 50/72규칙은 영어 문자의 기준으로 한글의 경우 글자의 폭이 영어와 다르기때문에 규칙을 적용하기가 까다롭습니다. 그래서 커밋 메시지를 작성하는 에디터(VSCode)에 몇가지 기능을 이용하여 에디터상에서 해당 글자만큼의 가이드라인이 표시되도록 설정하면 조금더 수월하게 작성할 수 있습니다.

참고: 링크

profile
WT Android

0개의 댓글