Git 커밋메시지 가이드
Git 커밋메시지를 작성하는 건 언제나 고민이다. 커밋당시에 코드변경 등 내용을 정확하고도 너무 길지도 너무 짧지도 않은 적당한 메시지를 적어야 하는데 쉽지 않다.
그래서 다음 conventionalcommits.org 의 커밋가이드를 간단하게 정리해 보았다.
커밋메시지 포맷
commit type : subject
body
footer
커밋타입(commit type)
- fix: 코드를 수정하거나 버그 수정
- feat: 새로운 기능을 추가했을 때
- chore : 그런트 작업 업데이트, 프로덕션 코드 변경 없음 (실제 프로덕션에 적용되지 않는 도구 변경이나 구성 변경)
- docs: 문서를 추가했을 때
- style: 코드 변경이 아닌 단순 포맷팅 변경 (새미콜론 제거 등)
- refactor: 코드를 리펙토링해서 개선했을 경우
- perf: 성능 개선
- test: 테스트코드를 추가한 경우
커밋제목(subject)
- 커밋 제목은 50자 이내로 요약하여 작성한다
- 주요내용에 대한 간단한 설명
내용(body)
- 제목과 내용사이의 한칸 띄우기
- 내용은 선택사항이며, 추가적인 설명이 필요할 경우 작성
바닥글(footer)
- 내용과 바닥글사이의 한칸 띄우기
- 바닥글 역시 선택사항이며, 주요 변경 사항에 대한 추가 참조가 필요할 경우 사용
사용예시
- 설명이 포함된 커밋 메시지 및 본문의 주요 변경 사항
feat: allow provided config object to extend other configs
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
- 본문이 없는 커밋 메시지
docs: correct spelling of CHANGELOG
Author And Source
이 문제에 관하여(Git 커밋메시지 가이드), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://velog.io/@bigdream96/Git-커밋메시지-가이드저자 귀속: 원작자 정보가 원작자 URL에 포함되어 있으며 저작권은 원작자 소유입니다.
우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)