커밋컨벤션
커밋 컨벤션(Commit Convention)은 코드 변경 내용을 기록하는 커밋 메시지를 일관되게 작성하기 위한 규칙이나 가이드라인입니다. 이러한 컨벤션은 팀원들이 커밋 메시지를 쉽게 이해하고, 프로젝트의 변경 내역을 보다 정리된 형태로 유지하는 데 도움을 줍니다. 일반적으로 사용되는 커밋 컨벤션에는 다음과 같은 요소가 포함됩니다:
타입(Type): 커밋의 종류를 나타내는 키워드입니다. 일반적으로 다음과 같은 타입이 사용됩니다.
feat
: 새로운 기능 추가fix
: 버그 수정docs
: 문서 변경style
: 코드 포맷팅, 세미콜론 누락 등 기능에 영향을 주지 않는 변경refactor
: 코드 리팩토링, 기능 변화 없음test
: 테스트 추가 또는 수정chore
: 빌드 과정이나 보조 도구 변경 등
제목(Subject): 커밋의 내용을 간략하게 설명하는 한 줄의 메시지입니다. 첫 글자는 대문자로 시작하고, 마침표는 생략하는 것이 일반적입니다.
본문(Body): 선택 사항으로, 커밋의 변경 이유나 추가 정보를 설명하는 부분입니다. 간단하고 명료하게 작성하며, 여러 줄로 작성할 수 있습니다.
후기(Footer): 선택 사항으로, 이슈 트래커의 참조 번호나 관련된 메시지를 추가할 수 있습니다. 예를 들어,
Closes #123
와 같은 형식으로 특정 이슈를 종료할 수 있습니다.
예시:
1
2
3
4
5
6
feat: 사용자 로그인 기능 추가
사용자가 이메일과 비밀번호로 로그인할 수 있는 기능을 추가했습니다.
추가적으로, 로그인 실패 시 에러 메시지를 표시하도록 했습니다.
Closes #45
이와 같은 규칙을 따름으로써, 프로젝트의 커밋 로그가 더 명확하고 관리하기 쉬워집니다. 팀 내에서 일관된 커밋 메시지 작성을 장려하는 것이 중요합니다.
이 기사는 저작권자의 CC BY 4.0 라이센스를 따릅니다.