문서에서는 Commit 메세지 작성 규칙에 대해 다룹니다.
개요
커밋 메세지 작성은 코드 히스토리를 관리하기 위해 중요한 작업 중 하나입니다. 이후에 검색하거나 확인하는 과정에서 비효율적으로 작성된 커밋 메세지는 히스토리 확인시 불필요한 시간을 소모할 수도 있고 보기에도 좋지 않습니다. 게다가 포맷이 통일되지 않으면 영어로 작성하는 사람, 한글로 작성하는 사람, 제각각 스타일대로 작성하다보면 작성하는 작업 자체도 매번 어떻게 작성해야 할지 고민하게 되기도 합니다. 따라서 협업을 위해 통일되면서 효율적인 작성 규칙을 수립하여 업무의 효율성을 증대하도록 합니다.
컨벤셔널 커밋
내가 소속한 팀은 Conventional Commits을 도입하고 적용하도록 했습니다. Conventional Commits은 말그대로 커밋 메세지를 위한 규칙입니다. 명확한 커밋 히스토리를 위한 간단한 규칙을 제공하고, 이를 사용하여 자동화된 도구를 만들기 쉽게 합니다.
커밋 메세지 포맷
커밋 메시지는 다음과 같이 구성되어야 합니다.
<type>: <title> (#issue-number)
<description>TYPE
타입의 종류와 내용은 다음과 같습니다.
| TYPE | 내용 |
|---|---|
| fix | 버그 수정 (patch versioning) |
| feature | 새로운 기능 추가 및 변경 (minor versioning) |
| refactor | 리팩토링 |
| style | 코드 스타일 수정 |
| docs | 문서 수정 |
| test | 테스트, 유닛테스트 관련 수정 |
| build | 빌드 관련 수정 |
TITLE
수정 사항에 대한 내용의 한줄요약을 한글로 작성합니다.
DESCRIPTION
수정한 목적(이유)과, 내용을 간결하고 명료하게 작성합니다.
예시
feat: 관심지역 알림 ON/OFF 기능 추가 (#123) - 시군구의 알림을 각각 ON/OFF 기능 추가 - 설정 파일 추가
커밋 메세지 템플릿 추가
커밋 메세지의 템플릿을 추가하여 사용합니다.
.gitmessage.txt 파일을 작성하여 다운로드 후, 다음 명령어를 입력합니다.
git config --global commit.template .gitmessage.txt커밋시 다음 git commit 명령 입력 시, 커밋메세지 템플릿이 열립니다.
참조
늘 성장을 꿈꾸는 자들을 위한 블로그입니다.