팀 프로젝트에 꼭 필요한 Commit Convention: 이슈 번호와 커밋 타입으로 관리하기

💬 Motivation

2022년 10월부터 Pullanner 프로젝트를 진행하면서, 프론트엔드 팀원과 함께 커밋 컨벤션을 정리해 보았다. 사실 작년 11월 24일에 완성했지만 팀 노션에만 저장해 두었다.

이번에 블로그에 업로드하게 된 계기는 원티드 프리온보딩 프론트엔드 인턴십 과정에 참가하여 팀 프로젝트를 하게 된 것이다. 함께 하게 된 팀원들과 커밋 컨벤션을 정해야 했고, 이때 정리된 문서를 보여주게 된다면 더 효과적일 것이라 생각했다.

팀원들이 나 포함 8명이었기 때문에 꽤 많았고, 각자가 사용해 왔던 커밋 컨벤션들을 돌아가면서 말하게 되었다. 이때 나는 정리해뒀던 커밋 컨벤션을 팀원분들께 보여드렸고, 이것이 최종 선택이 되었다.

여기서 깨달았던 것은, 정리해 둔 것은 언젠가 빛을 발할 수 있다는 사실이었다. 블로그에 정리를 해 두면 추후 바로 찾기도 쉽고, 또 다른 분들도 참고할 수도 있을 것이라는 생각이 들었다. 나도 다른 분들이 정리해 둔 것을 참고하여 팀원과 함께 작성한 것이고, 그중에서 자주 쓸 것 같은 타입을 모아두었으며 약간의 취향과 규칙을 첨가한 것이다.

나는 팀 프로젝트뿐만 아니라 개인 프로젝트에서도 이러한 컨벤션을 따르면서 커밋을 하는 것이 이제는 익숙하다.

지난날의 커밋들.

💬 Commit Type and Description

자주 쓰는 타입 위주로 정리해 보았다. 

이렇게 커밋에 타입을 명시해 두면, 코드의 변경 이유를 커밋 메시지의 타입만 보고도 캐치할 수 있기 때문에 매우 효율적이다. 

예를 들어, 커밋 메시지의 Feat만 보고도 '이 커밋은 새로운 기능을 추가한 코드가 있겠구나'라고 바로 파악할 수 있다. 

이러한 명확한 정보를 통해 코드의 변경 이유를 파악하는 시간을 줄일 수 있다. 

 

💬 Commit message & Description

[#Issue Number] Type: commit title

Description

커밋 타이틀에는 이슈 넘버를 대괄호로 표시한다.

이렇게 이슈를 명시함으로써 이 커밋이 어떤 이슈와 연관되어 있는지 쉽게 파악할 수 있다. 

팀원들이 이 이슈와 관련된 코드의 변경 사항을 쉽게 파악할 수 있고, 이는 작업의 효율성이 좋아지는 길이다. 

 

💬 Commit Rules

1. 커밋을 하는 단위는 커밋 메시지 한 줄로 설명할 수 있는 행동이어야 한다.
2. 커밋을 잘게 쪼개자 ― 커다란 커밋보단 너무 상세하더라도 작은 커밋이 더 낫다.
3. 복잡한 커밋보단 간단한 커밋 ― 한 커밋의 한 파일에서 2가지 액션이 들어가는 순간, 해당 커밋은 복잡한 커밋이 된다. (커밋의 type을 섞지 말자)

---

Reference

커밋을 잘게 쪼개자 - 커밋은 언제 하는 것이 가장 좋을까?