가취공부하자

git 커밋 메세지 쓰는 방법 본문

TIL

git 커밋 메세지 쓰는 방법

keepGGoing 2021. 8. 30. 16:46

git 커밋 메시지 잘 써야 하는 이유

1. 더 좋은 커밋 로그 가독성

2. 더 나은 협업과 리뷰 프로세스

3. 더 쉬운 코드 유지보수

 

좋은 깃 커밋 메세지 조건

1. 제목과 본문을 한 줄 띄워 분리하기

    커밋 메세지 : 50자 이내의 요약문장, 빈 줄 하나, 설명문 (강제사항은 아님)

    예외 상황

더보기

예시 1. 오타 한 글자 고침

예시 2. 빼먹은 거 고침

이러한 간단한 수정들은 굳이 위의 양식을 따라 하지 않아도 된다.

+ 제목은 최대한 간결하게!

 

2. 제목 끝에 . 금지

3. 제목은 명령조로 (이건 영어로 작성할 때 해당)

   -> 자세한건 참조한 블로그에,,

 4. 제목이나 본문에 이슈 번호 붙이기

  github는 #번호 로 된 부분을 해당 깃 헙 저장소의 이슈 번호로 인식하고, 클릭할 수 있는 링크로 바꿔줌.

  이를 통해 Github의 이슈와 개발 내역 관리 기능을 제대로 활용할 수 있다고 한다

{제목} #번호 - 본문

 5. 적절하게 줄 바꾸기

  -> 가동성을 위해

 6.  본문은 어떻게 보다 무엇을, 왜 에 맞춰 작성하기

 

   

 

<참고>

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

 

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

git커밋

meetup.toast.com