Git Commit Message 규칙

안녕하세요! 오늘은 Git Commit Message 를 작성할 때 규칙에 대해서 공부 해보려구 합니다! 

 

일단 왜 굳이 Commit Message 를 작성 할때 규칙에 맞게 작성 해야 할까요?

 

GitHub 를 사용하는 이유는 프로젝트 버전관리를 편히 하려구 하는 이유도 있지만 협업을 쉽게 하기 위해서 사용하는 경우도 있습니다

 

여러 사람들과 같이 협업해서 일을 하는대 Commit Message 가 자기 맘대로 작성하게 되면 같이 개발하는 개발자들 입장에서 

 

Commit Message 을 보고 현재 브런치의 개발 상황을 알아야 되는대 규칙이 없으면 이해하기 어려운 경우가 많습니다

 

그래서 Commit Message 를 규칙에 맞게 작성해야 다른 사람들이 볼 때도 이해하기 쉽습니다!

 

이 외에도 

1. 더 좋은 커밋 로그 가독성
2. 더 나은 협업과 리뷰 프로세스
3. 더 쉬운 코드 유지보수

가 있습니다! 

 

 

Commit Message 규칙은 총 7가지가 있습니다

 

1. 제목과 본문을 빈 행으로 구분한다
2. 제목을 50글자 내로 제한
3. 제목 첫 글자는 대문자로 작성
4. 제목 끝에 마침표 넣지 않기
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
6. 본문의 각 행은 72글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명한다

Commit Message 구조는 

type(타입) : title(제목)

body(본문, 생략 가능)

Resolves : #issue, ...(해결한 이슈 , 생략 가능)

See also : #issue, ...(참고 이슈, 생략 가능)

 

 

Commit Message 의 타입(type)에는

 

1. 커밋 유형 지정

• FEAT : 새로운 기능의 추가
• FIX: 버그 수정
• DOCS: 문서 수정
• STYLE: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
• REFACTOR: 코드 리펙토링
• TEST: 테스트 코트, 리펙토링 테스트 코드 추가
• CHORE: 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)

이렇게 7가지가 있습니다! 

 

개발자는 물론 개발을 잘하는 것도 협업하는 능력도 굉장히 중요하다고 생각합니다

 

이런 협업 하는대 있어서 Commit Message 를 규칙에 맞게 작성하는 것도 협업하는 능력을 기르는대 필수적인 지식이라고 생각합니다

 

우리모두 규칙에 맞춰서 Commit Message를 작성 해봅시다! 

 

 

 

아래 블로그는 제가 공부하면 참고 했던 블로그 입니다!

 

https://meetup.toast.com/posts/106

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