git commit 메시지 작성 시 description 곁들이기

요즘 소스트리가 윈도우에서는 켜지지도 않고, 맥에서는 푸시가 안되고...

이래저래 문제가 많은 와중에 굳이 삭제하고 다시 깔기도 귀찮아서 터미널에서 커맨드를 쓰거나 fork 라는 것을 대신해서 쓰고 있다.

fork에서는 description쓰는 ui가 편하게 돼있는데 소스트리에서는 description쓰는 것이 안보여서 커맨드로 description을 추가하려면 어떻게 하나 찾아봤다.

 

 

먼저 앞으로 쭉 이렇게 사용하고싶다면 이걸 실행하자.

 

git config --global core.editor "code --wait"

 

 

 

 

내 로컬의 git 환경설정에서 git commit 명령어를 치면 위와 같이 vscode창을 띄워서 커맨드 메시지와 description을 작성할 수 있는 vscode창이 생긴다.

 

 

위에서 '잘 작성 되겠거니...' 를 추가했으니 신경쓰지 말 것

커밋 메시지를 작성하고서 켜진 창을 끄면 다음과 같은 상태가 뜬다.

이대로 git push 를 진행한 결과는 다음과 같다.

 

아주 잘 됐다.

줄바꿈까지 알아서 바꿔주고 편하다. 

 

 

+α

굳이 description까지 곁들여야하는 것은...

일반적으로 커밋을 생성할 때 설명을 작성하는 것이 좋다고 한다.

왜냐하면 잘 만들어진 커밋 메시지는 변경 사항의 목적과 맥락을 전달하는 데 도움이 되고,

다른 사람이나 미래의 내가 커밋 의도를 더 쉽게 이해할 수 있으니까.

 

 

잘 구성된 git commit 메시지 예시의 경우 다음과 같다.

Add user authentication feature

This commit adds a new feature for user authentication.
It includes the necessary routes, controllers, and UI components
to allow users to register, log in, and log out of the application.

Fixes #123

 

 

참고

 

stackoverflow

How to commit a change with both "message" and "description" from the command line?

 

 

vscode

Source Control with Git in Visual Studio Code