https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53
조금 더 편하게 한국어로 해석한 뒤, 최대한 이 규칙을 지키기위해 신경쓰는 연습을 하자.
시간을 정해서 하는 커밋이 아닌 기능에 기반한 커밋을 하자. 글씨 수정, 잘못된 파일 들여쓰기 등등. (히스토리로 이슈를 추적하는데 쓸데없이 많은 커밋은 읽기 어렵다.)
rules
Git커밋 메세지 스타일에 대한 규칙
빈 칸으로 본문에서 제목을 구분한다.
제목란을 마침표로 끝내지 않는다.
주제과 그 단락을 대문자로 표시한다.
주제 안에서는 반드시 해야하는 말을 사용해라.
50자 이내의 요약문장과 빈 줄 하나, 그리고 설명문으로 구성
본문에는 어떤 것을 '왜'했고,'무엇'을 했는지 사용해라.
팀에서 정의한 커밋 규칙을 따라라.
commit message
변경이 이루어지는 정보를 설명해라.
그 문제에 대해서 어떻게 고민하고 있는가
패치가 주는 영향은 무엇인가
리뷰어가 원래의 문제를 이해하고 있다고 추측하지마라
코드가 따로 증명할 필요가 없거나 번역하지 않아도 된다고 추측하지 마라.
커밋 메세지가 코드 구조의 개선을 암시하는지 확인해라.
첫번째 커밋라인이 가장 중요하다.
현재 코드의 어떠한 제한사항이라도 설명해라
패치관련 설명을 포함하지마라.
커밋이 이슈를 언급하는 경우, 정보를 커밋메세지 헤더나 본문에 추가한다.
커밋의 타입을 설명하는 것
feat: 내가 추가하는 특정 기능의 새로운 특징
fix: 버그에 대한 수정
style: 스타일링과 괕련된 특징과 업데이트
refactor: 특정 코드베이스 부분 리팩토링
test: 테스트와 관련된 모든 것
docs: 문서와 관련된 모든 것
chore: 정기적으로 하는 코드 유지보수최대한 말에 맞게 번역을 해도 어색한 감이 있다.
예시로 연습을 해보자
Feat: 게시글을 클릭 시 게시글에 대한 세부정보를 나타내는 컴포넌트 생성
게시글에 대한 정보는 useParams()를 이용하여 파라미터로 API 호출.
스타일링은 작업하지 않음.
resolves: #123Fix: 게시글 클릭 시 API호출이 2번되는 기능 수정(#111)
게시글 클릭 시 게시글에 대한 세부정보를 받아오는 API호출이 두 번됐음.
의존성 주입을 통해, API호출을 한 번만 할 수 있도록 수정.
해결: close #111