git: Commit Message 작성하기

1086 단어 gitTILTIL

commit message

커밋 메시지는 형상관리 시 검색어로 사용될 수 있으며,
협업을 하는 상대방과 소통하는 언어다.

때문에 commit message convention은 매우 중요하고 기본적인 것
** convention = 협약

commit convention

커밋도 많은 코드 스타일과 마찬가지로 정해진 룰은 없지만
권장하는 가이드라인이 있다.

git commit -m "type: Subject \[body] \[footer]"
git commit -m "type: Subject 
\[body] 
\[footer]
"

type:

50자 이내의 핵심 요약

Feat: 새로운 feature 추가
Fix: 코드 수정 (오류 등의 수정)
Docs: 문서 변경
Style: 코드가 아닌 스타일 수정 (포맷, 세미콜론 등)
Refactor: 리팩토링 프로덕션 코드
Test: 테스트 코드 추가, 리팩토링 테스트 등 (프로덕션 코드가 아닌)
Chore: 빌드 태스크 수정, 프로젝트 매니저 설정 수정 등 (프로덕션 코드가 아닌)

body

72자마다 줄바꿈
어떻게 보다 무엇을, 왜에 맞추어 작성
헤더로 표현할 수 없는 상세 내용 (생략 가능)

footer

GitHub 이슈를 자동으로 종료

키워드 #이슈번호
  • close, closes, closed
  • fix, fixes, fixed
  • resolve, resolves, resolved

좋은 웹페이지 즐겨찾기