Git 커밋 메시지를 조금 더 잘 적어보자.
1. Git 커밋 메시지 컨벤션이란?
Git 커밋 메시지 컨벤션은 프로젝트의 일관성을 유지하고, 가독성을 높이며, 관리와 유지보수를 용이하게 하기 위해 정해진 규칙이다.
이 규칙을 따르면, 팀원 모두가 어떤 작업이 이루어졌는지 쉽게 이해할 수 있다.
2. 커밋 메시지 구조
일반적으로 커밋 메시지는 아래와 같은 구조를 가지며, 이러한 구조를 따르는 것이 좋다.
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>- type: 커밋의 종류(예: feat, fix, chore, docs 등)
- scope: 커밋의 영향 범위(예: user authentication, payment gateway 등)
- subject: 커밋의 간단한 설명
- body(optional): 커밋의 자세한 설명
- footer(optional): 이슈 트래커 ID 등의 추가 정보
3. type의 종류
- feat: 새로운 기능 추가
- fix: 버그 수정
- docs: 문서 수정
- style: 코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우
- refactor: 코드 리팩토링
- test: 테스트 코드, 리팩토링 테스트 코드 추가
- chore: 빌드 업무 수정, 패키지 매니저 수정
4. 예시
feat(user): 사용자 로그인 API 추가
사용자가 시스템에 로그인할 수 있게 하는 로그인 API 추가.
이 API는 사용자의 인증 정보를 검사하고 jwt 토큰을 반환함.
관련 이슈: #123#123 feat(user): 사용자 로그인 API 추가
사용자가 시스템에 로그인할 수 있게 하는 로그인 API 추가.
이 API는 사용자의 인증 정보를 검사하고 jwt 토큰을 반환함.- 두 예시의 관련 이슈 번호를 적는 위치는 팀이나 프로젝트에 따라 다르므로, 팀 내에서 이에 대해 논의하고 결정하는 것이 중요.
고통 받는 코딩일기