20221202 TIL 더 나은 형상 관리를 위하여

https://www.google.com/imgres?imgurl=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F18133%3Fs%3D200%26v%3D4&imgrefurl=https%3A%2F%2Fgithub.com%2Fgit&tbnid=WcYFjdHNXDXQsM&vet=1&docid=0K7OkEpR0MqFpM&w=200&h=200&hl=ko-KR&source=sh%2Fx%2Fim

Git을 써온지도 벌써 1년이 다 되어간다.
git을 다루는 것은 이제 더이상 두렵지 않아졌고,
git과 관련된 도움을 요청받았을 때 대부분의 상황을 해결할 수 있는 수준이 되었다.

하지만 git branch이름, git commit 내용을 잘 작성하기는 아직도 어려운 것 같다.
과제를 진행하면서 branch명과 commit내용을 작성하다가 이렇게 간단하게만 작성을 해도 되는 것일까,
더 잘 작성하는 방법은 없을까 고민을 하다가 컨벤션을 찾아보고, 더 나은 커밋을 작성하는 방식을 골라보았다.

먼저, 깃 브랜치명은 '간략한 설명'으로 작성하기로 결정했다.
지금은 티켓을 만들고 있지는 않기 때문에
이 브랜치에서 할 업무에 대한 간략한 설명을 하이픈 '-'을 이용해서 작성하는 방식을 택하기로 했다.
티켓을 작성하게 되면 '티켓id/간략한 설명' 을 사용하면 좋을 것 같다.

그리고 커밋을 할 때 커밋 제목은 무엇을 했는지와 작업의 목적을 함께 작성하면 좋을 것 같고,
메시지에는 이 커밋에서 어떤 변경이 발생했는지, 어떤 작업을 했는지를 풀어쓰면 좋을 것 같다.

내가 정한 방식으로 내가 작성했던 커밋 메시지를 리팩토링 해보았다.
e2e테스트를 돌리기 위한 전제를 충족시키기위해 backdoor api를 사용한 작업에 대한 커밋이었고,

기존 커밋 메시지

Use backdoor api

Use backdoor api.

리팩토링한 커밋 메시지

Use backdoor api in e2e tests to set up the test environment

Reset the database to make tests run independently.
Add items to check pagination works well.

으로 수정할 수 있었다.

커밋 메시지를 제대로 작성하는데 꽤 오랜 시간이 걸렸다.
아직 어렵지만, 커밋 메시지를 제대로 작성해두어야 함께 작업하는 사람들도 이해하기도 쉽고,
나 또한 무슨 작업인지 파악하기 편리하다.
조금 시간이 걸리더라도 커밋 메시지에 작업의 목적을 드러내고,
가장 중요한 변화를 남겨둘 수 있도록 커밋 메시지를 작성할 때 조금 더 주의를 기울여야겠다.