[git] 커밋메시지 작성

cateto·2022년 7월 4일
0
post-thumbnail

양질의 커밋 메시지를 작성하는 습관을 들이면 Git을 사용하고 협업하는 것이 훨씬 쉬워집니다.
— Pro Git Book

커밋메시지 출력

git show --pretty=fuller -s HEAD

일반 커밋 메시지 지침

  • 짧게 유지(총 150자 미만)
    • 한 번에 더 적은 수의 변경을 커밋하면 이 문제에 도움이 됩니다.
  • 명령형으로 작성
    • git merge 와 같은 명령어와 유사
    • 읽기 및 이해의 속도 향상
    • 다른 무드 보다 간결한 경향이 있음
  • 제목 추가
    • 50자 미만
  • 본문 추가(선택 사항)
    • 100자 미만
    • 변경 사항이 무엇인지 설명하되 특히 변경 사항이 필요한 이유
    • 제목과 본문 사이에 공백을 두십시오.
    • 필요한 경우 글머리 기호에 하이픈(-)을 사용

잘못된 커밋 예:

debugging
I've added a delete route to the accounts controller

좋은 커밋 예:

Enable Logging Globally
Add Account Delete Route

Needed for account deletion workflow on frontend

시멘틱 커밋 메시지

참고

  • 형식
<type>(<scope>): <subject>
  • 예시
feat: add hat wobble
^--^  ^------------^
|     |
|     +-> 현재형으로 작성된 요약 메시지
|
+-------> 커밋 타입: chore, docs, feat, fix, refactor, style, or test.

feat: (빌드 스크립트의 새로운 기능이 아닌 사용자를 위한 새로운 기능)
fix: (빌드 스크립트에 대한 수정이 아닌 사용자를 위한 버그 수정)
docs: (문서에 대한 변경 사항)
style: (형식 지정, 세미콜론 누락 등, 프로덕션 코드 변경 없음)
refactor: (생산 코드 리팩토링, 예를 들어 변수 이름 바꾸기)
test: (누락된 테스트 추가, 테스트 리팩토링, 프로덕션 코드 변경 없음)
chore: (그런트 작업 업데이트 등, 프로덕션 코드 변경 없음)

Auto-commit-message (VSCODE 익스텐션)

  • 링크
  • vscode에서 확장을 설치하여 오토 커밋메시지를 생성할 수 있다!
  • 위의 언급된 시멘틱 커밋 메시지를 기반으로 함
  • 이 기능을 사용하는 경우 자주 커밋해야 세부 사항을 볼 수 있어 좋을듯!
profile
Curious for Everything

0개의 댓글