https://github.com/angular/angular/commits/master
개발을 하다보면 수 많은 commit message 를 작성하는데, 좋은 규칙이 없을까? 라는 궁금함이 생겨 찾아보던 도중에, 좋은 commit message 규칙에 따라 진행하고 있는 프로젝트 예시를 발견했습니다.
기본적으로 commit message 는 제목, 본문, 꼬리말로 구성합니다.
제목은 필수사항이며, 본문과 꼬리말은 선택사항입니다.
<type>: <subject>
<body>
<footer>
Type 과 함께 헤더를 구성합니다. 예를들어, 로그인 API 를 추가했다면 다음과 같이 구성할 수 있습니다.
ex) feat: Add login api
헤더로 표현이 가능하다면 생략이 가능합니다. 아닌 경우에는 자세한 내용을 함께 적어 본문을 구성합니다.
어떠한 이슈에 대한 commit 인지 issue number 를 포함합니다. 위의 좋은 예시에서는 (#1)
처럼 포함시켰습니다. 그리고 close #1
처럼 close 를 통해 해당 이슈를 닫는 방법도 있습니다.