지난일을 돌이켜보면, 전자과를 졸업하고, 주변에 컴공친구들이 없다보니 자연스럽게 모든개발을 독학으로 하게되었다. 초반에는 배워야할게 단지 개발관련 지식이다보니 협업을 할때 중요한 것들을 놓치게 된 것 같다.
반대로 생각해보면, 동료가 남긴 너무 간단하거나 모호한 커밋메시지를 보면 나또한
어..?뭐가 변경된거지? 하고 커밋을 살펴보겠지...
개인프로젝트도 협업을 한다는 마인드로 진행했다면 하는 아쉬움이 남는다 😢
원대한 목표보다는, 어제보다 나은 내가 되기위해 좋은 레퍼런스를 보고 노력해야겠다.
커밋 메시지의 7가지 규칙
- 제목과 본문을 빈 행으로 구분한다
- 제목을 50글자 내로 제한
- 제목 첫 글자는 대문자로 작성
- 제목 끝에 마침표 넣지 않기
- 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
- 본문의 각 행은 72글자 내로 제한
- 어떻게 보다는 무엇과 왜를 설명한다
9가지 Commit Type
feat : 새로운 기능에 대한 커밋
fix : 버그 수정에 대한 커밋
build : 빌드 관련 파일 수정에 대한 커밋
chore : 빌드관련, config 에 관한 것들 등등 개발코드 외의 변경들
ci : CI관련 설정 수정에 대한 커밋
docs : 문서 수정에 대한 커밋
style : 코드 스타일 혹은 포맷 등에 관한 커밋
refactor : 코드 리팩토링에 대한 커밋
test : 테스트 코드 수정에 대한 커밋
커밋메시지 구조
type: Subject
개행
body
개행
footer
-
type : 커밋type (위에 9 가지 유형을 참고해서)
-
subject : 최대 50글자가 넘지 않도록 하고 마침표는 찍지 않는다.
동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기한다. -
body(option) : 필수는 아니다. 커밋에대한 보충설명이 필요한경우 작성하자.
결과만 쓰지말고, 무엇을 왜 했는지에 초점을 맞춰 작성. 최대 72자를 넘기지 않도록 한다 -
footer(option) : issue tracker ID를 명시(선택)
body 작성하기
- commit을 통해 무엇을 해결했는지 설명한다.
- 왜 코드의 변화를 주었는지 이유를 작성한다.( why(o) how(x) how는 코드를 직접까보면 알수있지)
- 사실 이부분이 제일 어렵지.. 여기는 일기장이아니다 ㅠㅠ 주절주절 TMI를 하지않도록 조심조심 좋은사례들을 다음포스팅에서 물어오겠습니다
설명보다는 실제 사례들을 보고 체득하는게 훨씬 빠를 것 같다. 계속해서 눈에익히고 어설프게라도 따라해 봐야지 😗
커밋타입도 더 보충할게 있는 것 같다. 다음포스팅에 보충하기로...
Ref.
