장문(2줄 이상)의 커밋 메세지를 남기고 싶을 때

우리는 커밋을 할 때에 보통 변경사항을 요약한 짧은 커밋 메세지와 함께 커밋 요청을 한다. 그런데 추가 설명이 필요하여 커밋 메세지를 장문으로 작성해야 할 때가 있다. 이번 포스팅에서는 2줄 이상의 커밋 메세지를 작성하고 싶을 때 어떻게 하면 되는지 정리해두려고 한다.

 

 

장문의 커밋 메세지 작성하는 방법

테스트를 위해서 commit_test.txt 라는 파일을 새로 만들었다.

 

 

터미널을 실행한 후에 git add . 명령어를 입력하여 변경된 파일을 Staging Area에 추가하고 git status로 상태 확인도 마쳤다. 

 

 

이제 commit을 할 차례인데 장문의 커밋 메세지를 남기기 위해 옵션 없이 git commit 명령어를 실행시켰다.

 

git commit

 

이렇게 하면 터미널 창이 아래와 같은 화면으로 바뀐다.

 

 

i 키를 누르면 상태가 -- INSERT -- 로 변경(하단에서 확인 가능)되며 커서가 보일 것이다. 커밋 메세지를 작성한다.

 

 

블라 블라 ~ 지금은 아무말 대잔치중 ~ 😀

커밋 메세지를 모두 작성했다면 esc 키를 누르고 :wq 라고 입력한 다음 엔터키를 누른다.

 

 

:wq 는 '저장 후 닫기'라는 의미이다.

 

 

터미널 화면이 다시 원래대로 돌아왔으며 commit 결과도 확인할 수 있다.

 

 

git log 명령어를 실행해서 마지막으로 한 커밋의 내용을 살펴보았다. 아무말 대잔치 커밋 메세지가 잘 등록되어 있다. 

앞으로 이러한 장문(2줄 이상)의 커밋 메세지를 등록하고 싶을 때에는 '-m' 옵션을 생략하고 위와 같은 방법을 사용하면 된다. 나도 vim 문서를 다루는 것이 낯설지만 그래도 친해질 수 있도록 노력해보려고 한다.

---

Git에서 권장하는 커밋 메세지 작성 방법

한가지 팁을 더 정리하자면, Git에서 공식적으로 권장하는 커밋 메세지 작성법이 있다. 필수는 아니지만 커밋 메세지는 변경 사항을 요약하는 50자 미만의 짧은 한 줄로 시작하고, 추가 설명이 있는 경우 사이 한 줄을 비워두는 것이 좋다고 한다. 그러면 커밋 메세지의 첫번째 줄은 커밋 제목으로 처리되며 해당 제목은 Git 전체에서 사용된다. 더 자세한 내용은 아래 링크에서 확인할 수 있다.

https://git-scm.com/docs/git-commit#_discussion

Git - git-commit Documentation

 

그 밖의 권장사항(?)은 아래와 같다. 

• 커밋 메세지 제목에는 마침표(.) 사용하지 않기
• 커밋 메세지 제목의 첫번째 알파벳은 대문자로 작성하기
• 커밋 메세지 상세 내용에 담으면 좋은 것 : 커밋 이유, 어떤 문제가 있었는지, 적용한 해결책의 효과 등
• 되도록 하나의 커밋에 하나의 수정사항 담기
• 커밋 시점에서 에러가 발생하지 않는지 확인하기