728x90
📌 깃 커밋 메시지 컨벤션 Git Commit Message Convention
Git Commit Message Convention(깃 커밋 메시지 규칙)은 협업 프로젝트에서 효율적인 커밋 메시지 작성과 변경 이력을 쉽게 이해할 수 있도록 돕는 규칙입니다. 일반적으로 이 규칙은 커밋 메시지를 일관되고 명확하게 작성하기 위해 사용되며, 다음과 같은 구조와 형식을 따릅니다.
📌 기본 구조
<타입>: <제목>
<빈 줄>
<본문>
<빈 줄>
<푸터>
1. 타입(Type):
커밋의 목적을 나타내는 필수 항목으로, 작업의 성격을 설명합니다. 일반적으로 사용되는 타입은 다음과 같습니다.
- feat: 새로운 기능 추가
- fix: 버그 수정
- docs: 문서 변경 (예: README 수정)
- style: 코드 스타일 변경 (포맷팅, 세미콜론 추가 등, 코드 자체 변화는 없음)
- refactor: 코드 리팩토링 (기능 변화 없이 코드 구조 개선)
- test: 테스트 코드 추가 또는 수정
- chore: 빌드 프로세스 수정, 패키지 매니저 설정 등 (코드 변경 없음)
2. 제목(Subject):
짧고 간결하게 커밋의 요점을 설명합니다. 50자 이내로 작성하며, 대문자로 시작하고 마침표는 생략합니다.
영문 표기 시, 첫글자는 대문자로 표기하며 과거시제를 사용하지 않는다.
feat: 사용자 로그인 기능 추가
fix: 비밀번호 재설정 오류 수정
3. 본문(Body):
필수는 아니지만, 커밋의 동기나 주요 변경 사항을 더 자세히 설명할 때 사용합니다. 본문은 어떻게(What)가 아닌 왜(Why)와 무엇(What)에 중점을 두어 작성하며, 72자 이내로 줄바꿈을 합니다.
- 로그인 화면에서 아이디와 비밀번호 입력 시 검증 로직 추가
- 검증 후 JWT 토큰 발급 기능 구현
4. 푸터(Footer):
특별한 사항이 있을 때 작성합니다. 예를 들어, 이슈 번호를 참조하거나, 브레이킹 체인지(Breaking Changes)가 있을 때 표시합니다.
BREAKING CHANGE: 데이터베이스 스키마가 변경되어 이전 버전과 호환되지 않음.
Closes #123
예시:
feat: 사용자 프로필 페이지 추가
- 프로필 페이지 UI 구현
- 사용자 정보 수정 기능 추가
- 프로필 사진 업로드 기능 구현
Closes #456
728x90
'Git' 카테고리의 다른 글
[Git] Github 리포지토리 이름 변경 후 재연동하기 (0) | 2024.05.28 |
---|---|
[Git] user.name, user.email 를 global,local에 따라 설정하기 / 잔디밭이 채워지지 않는 경우 해결법 (0) | 2024.05.22 |
[Github] Eclipse git에서 import 시 아이디/패스워드 입력 실패 시 (0) | 2024.03.04 |
[Git] 정의 및 기본 명령어 / vi 에디터 (1) | 2023.12.19 |