커밋 메세지 규칙을 알아보자

오늘은 git commit 메세제 작성 규칙에 대해 알아보자. 본인도 해당 규칙이 아직 습관이 되지 않아 힘들지만... 최대한 숙지하고 사용하기 위해 이번 글을 작성해본다.

커밋 메세지를 왜 쓰는거죠?

커밋 메시지는 코드 변경 사항을 설명하는 중요한 도구다. 좋은 커밋 메시지는 협업을 원활하게 하고 코드 리뷰, 디버깅 과정에서 큰 도움이 된다. 이 글에서는 좋은 커밋 메시지를 작성하기 위한 7가지 규칙과 실질적인 예시를 다뤄보겠다.

1. 커밋 메세지 작성의 7가지 규칙

1. 제목과 본문을 빈 행으로 구분한다.

   • 빈 행을 사용해 제목과 본문을 구분하면 메세지 가독성이 높아진다!

     fix: Carousel 모달 스크롤 이슈 해결
     
     모바일 Safari에서 모달 띄울 때 발생하던 스크롤 문제를 수정했음.

2. 제목은 50글자 이내로 제한한다.

   • 제목을 간결히 작성하여 핵심을 전달해야 한다.

     feat: 검색 기능 추가

3. 제목의 첫 글자는 대문자로 작성한다.

   • 크게 의미는 없는 것 같은데... 영어권 이라고 생각하면 이해는 되는 항목이다.

     docs: Add to install guide

4. 제목 끝에는 마침표를 넣지 않는다.

   • 불필요한 구두점을 배제하여 깔끔하게 표현해야 한다.

     update: CSS 정리 및 불필요한 주석 제거

5. 제목은 명령문으로 작성하고, 과거형을 사용하지 않는다.

   • 제목을 명령문으로 작성하면 변경 의도를 더 명확히 전달 할 수 있다. (그냥 최대한 핵심만 말하자.)

     refactor: 불필요한 변수 제거 및 코드 정리

6. 본문의 각 행은 72글자 내로 제한한다.

   • 본문은 줄바굼을 통해 가독성을 높여야 한다.

     feat: 새로운 API 엔드포인트 추가
     
     특정 조건에서 데이터를 필터링하기 위한 새로운 API 엔드포인트를 추가했음.
     성능을 개선하고 사용자 요청을 처리할 수 있도록 최적화했음.

7. 과정보단 결과 위주로 설명한다.

   • 변경 이유와 의도를 명확히 작성해야 한다.

     perf: 이미지 로딩 속도 최적화
     
     CDN을 활용하여 정적 자원의 로딩 속도를 향상시켰음.
     대기 시간을 줄이고 사용자 경험을 개선했음.

2. 커밋 메세지의 구조와 예시

우선 해당 내용을 진행 하기에 앞서 커밋 메세지 규칙은 틀은 비슷하겠지만 회사마다 조금씩 상이한 경우도 있으니 이 점 유의하길 바란다.

1. Header (필수)

   • 제목으로 간결한 변경 사항 요약을 작성하기 위해 사용하자.

   • 타입 : 주제

     feat : 로그인 기능 구현

2. Body (선택)

   • 변경 이유와 구체적인 내용을 작성할 때 쓰자.

     feat: 로그인 기능 구현
     
     JWT를 사용해 인증 로직 구현했음.
     로그인 실패 시 적절한 에러 메시지를 반환하도록 처리했음.

3. Footer (선택)

   • 이슈 번호나 추가 정보를 넣고 싶을 때 사용하자.

     fix: Carousel 모달 스크롤 이슈 해결
     
     모바일 Safari에서 모달 띄울 때 발생하던 스크롤 문제를 수정했음.
     
     Issues #1234 // 이슈 번호같은 부가 정보

3. 커밋 타입 정리

• 커밋 타입을 표로 정리해보았다.

한번에 외우기보단 천천히 숙지하는 방향으로 진행해보자.

결론

좋은 커밋 메시지는 프로젝트의 성공을 좌우한다.

명확하고 체계적인 커밋 메시지는 단순히 기록을 남기는 데 그치지 않는다. 협업, 코드 리뷰, 디버깅 과정에서 효율성을 높이고 프로젝트의 유지보수성을 강화한다. 항상 "무엇을 변경했는가?"와 "왜 이 변경이 필요한가?" 를 중심으로 커밋 메시지를 작성 하는 것이 좋아 보인다. 코드 품질 뿐만 아니라 팀워크까지 강화할 수 있을 것이다.