[git] commit message 잘 적는 팁 (+ git merge 취소하기)

회사에서 협업을 하게 되면서 '[2023-07-01] OOOpage 모달창 제작' 이런 식으로 적게 되었는데,

별 신경안쓰고있고 여기서 더 잘 쓸 수가 있어야 하나? 간결하고 보기 좋은데.. 해서 신경 안 썼던 것 같다.

그러다가 문득 잘 작성하는 방법이나 조금 더 잘 이해할 수 있도록 적는방법이 있을까? 해서 알아보았다.

 

---

 

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

1. 일관적이고 명확한 내용이 들어간 커밋 메시지는 다른 개발자가 산출물을 더 잘 이해할 수 있도록 돕는다.

2. 잘 작성된 커밋 메시지는 코드에서 문제가 발생했을 때, 더 쉽고 편하게 디버깅이 가능하게 한다.

3. 잘 작성된 커밋 메시지는  프로젝트의 맥락을 이해하는데 도움을 준다. 즉 해당 프로젝트에서 함께 작업하는 다른 개발자와 본인에게 변경 사항에 대한 콘텍스트를 전달한다.

 

좋은 커밋 메시지를 작성하는 방법

1. 제목에 어떤 내용을 담은 커밋인지 커밋 유형을 알 수 있도록 제목을 설정한다.

2. 누구나 어떤 내용인지 쉽게 파악할 수 있도록 자세하고 꼼꼼하게 commit body 를 작성한다.
( 커밋 메시지만 봐도 어떤 개발을 진행했는지 알 수 있도록)

3. 커밋메시지는 명령어 혹은 요청하는 어조를 사용한다.

4. 불필요한 구두점은 제거한다.

5. 팀에서 정의한 커밋 컨벤션을 완벽하게 지킨다.

 

 

이런 규칙만 잘 지킨다고하면, 내가 어떤 내용에 대한 개발을 할지 명확하게 구분이 가능하며,
동료의 산출물을 리뷰하는데도 좋은 도움이 될 것 같다.

 

---

 

git merge 취소하기

다른 branch 와 commit merge 중에 confict 가 나서 merge 전으로 돌리고 싶을 경우 다음 명령어를 입력하면 merge 이전 상태로 돌아간다! 

 

사실 저거만 쓰기 뭔가 허전해서

git merge --abort

 

다들 즐겁고 행복한 코딩 하세요!