Game Tech Blog
:: 훌륭한 깃 커밋 메시지 본문
훌륭한 깃 커밋 메시지란
> 프로그래밍을 하고자 할때, 가장 고민되는 부분은 함수,클래스,변수등의 이름을 어떻게 짜면 조금 더 나를 포함한 팀원이 직관적이게 알아 볼 수 있을까? 이다.
몇 바이트 안되는 데이터의 이름을 짤때도 고민이 되는 부분이 있는데, 하루 작업의 결과물인 코드라인을 올리는 것은 조금 더 직관적이고 신중해야 할 필요가 있다고 본다.
깃 구축에 대해 알아보다가 좋은 커밋 메시지 작성이라는 글을 봤다.
회사에서 업무 진행하면서 디폴트로 잡혀놓은 커밋 메시지 규격이 있었는데, 이 글과 많이 유사해 나중에 진행하는 프로젝트에 적용하려고 포스팅 한다.
훌륭한 커밋 메시지 작성을 위한 7가지 규칙
- 공백 라인으로 본문, 주제를 구분
- 제목 줄을 50자로 제한
- 제목 첫 글자는 대문자 시작
- 제목 줄을 마침표로 끝내지 마라
- 제목엔 명령형 어투 사용
- 본문은 72자로 줄바꿈
- 바디를 사용하여 무엇 -> 어떻게, 왜? 를 설명
깃 커밋 메세지의 세부적인 타입
- feat : 새로운 기능 추가할 경우
- fix : 버그 수정
- docs : 문서 수정
- style : Code formatting, 코드의 형식, 또는 보기 편하게 포매팅을 바꾸는 경우
- refactor : 코드 리팩터링
- comment : 필요한 주석 추가 및 변경
- rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
- remove : 파일을 삭제하는 작업만 수행한 경우
- !BREAKING CHANGE : 커다란 API 변경의 경우
- !HOTFIX : 급하게 치명적인 버그를 고쳐야 하는 경우
참고자료
Writing git commits that everybody understands — especially your team
Basic guidelines, rules, information to display, do’s and don’ts, necessity
yuiltripathee.medium.com
How to Write a Git Commit Message
Commit messages matter. Here's how to write them well.
cbea.ms
https://cocoon1787.tistory.com/708?category=924716
[Git] 좋은 커밋 메시지 작성법
🚀 프로젝트 협업을 할 때 커밋 메시지 작성은 필수입니다. 입사 면접에서도 커밋 컨벤션에 대해 종종 질문이 나오는 걸로 알고 있습니다. 아직까지 협업 경험이 없는 상태에서 개인 프로젝트
cocoon1787.tistory.com
'협업 툴 > Git' 카테고리의 다른 글
| Git Trouble:: 0. Authentication failed 해결법 (0) | 2022.11.21 |
|---|---|
| :: 0. 깃 구축 (0) | 2022.09.05 |
