이때까지 저에게 github은 그냥 코드 충돌만 안나게 잘 올리고, 잘 받아오면 되는 그런 도구 였습니다.
하지만, 이번에 진행하게 된 원티드x코드스테이츠 프리온보딩 코스에서 다른 팀원들과 현업을 통해서 커밋 메시지만으로도 다른 팀원들이 어떤 기능을 구현하고 어떻게 처리하는지를 손 쉽게 알 수 있고, 충돌 시 특정 시점으로 돌아갈때도 메시지만 잘 작성 되어 있다면 많은 시간을 절약할 수 있는 것을 알게 되었습니다.
그래서 커밋 메시지에 따른 규칙과 사용방법에 대해서 제가 공부한대로 설명하겠습니다.
커밋 메시지 규칙
커밋 메시지는 제목과 본문으로 나누어 지는데 제목만 넣어서 설명이 충분하면 제목만 넣어도 됩니다.
하지만 어떤 것이 변경되었고, 설명이 필요하다면 부연 설명도 작성을 해주어야 다른 팀원들이 쉽게 이해할 수 있습니다.
제목에도 약간의 규칙이 있습니다
보통 제목 같은 경우는 영문으로 적고, 첫글자는 대문자로 적어줍니다.
그리고 동사(원형)을 가장 앞에 두고, 제목 뒤에는 콜론(:)으로 분리 해줍니다.
제목은 명렁어, 개조식으로 작성해주며 제목 끝에 닷(.)은 금지합니다.
아래 표는 제목 예시입니다.
본문 (body)
아까도 말했지만 본문은 필수가 아닙니다.
제목만으로 설명이 되지 않아 분연설명이 필요할때만 작성해주면 되고, 내용은 72자 미만으로 작성해줍니다.
그리고 본문은 무엇을 변경했고, 왜 변경했는지에 초점을 맞추어 작성해주면 좋습니다.
꼬리말 (footer)
추가로 꼬리말도 있는데요
꼬리말 같은 경우도 선택사항이기에 필수는 아니지만,
이슈 트래커 id를 작성할 때 주로 사용합니다.
유형: #이슈 번호 형식으로 작성합니다.
유형은 아래 예시 중 하나를 사용합니다.
commit 간단한 예시
Feat:"회원가입 기능 구현" // 제목
이메일 주소, 전화번호 유효성 검사 기능 추가 // 본문
Resolves: #57 -> 꼬리말
Ref: #54
Related to: #43, #44
깃이모지로 commit을 좀 더 이쁘게 꾸밀 수도 있습니다!
.png)