커밋 컨벤션 설정하기

커밋 컨벤션 설정하기

커밋 컨벤션이란?

프로젝트 참여자들이 일관된 형식의 커밋 메시지를 작성하기 위한 규칙을 말한다.

커밋 컨벤션의 중요성

일관된 커밋 메시지의 형태를 유지하면 가독성을 높일 수 있고, 소스 변경 이력을 효율적으로 추적할 수 있다.

또한 코드 리뷰 및 버그 수정 과정에서 불필요한 의사소통 과정을 간소화해 프로젝트 관리에 들어가는 시간을 줄일 수 있다.

 

기본 포맷

타입 : 태그 + 제목

타입

영어로 쓰되 첫 문자는 대문자로 하며 종류는 다음과 같다.

• Feat(페이지 경로 또는 컴포넌트): 새로운 기능 추가  또는 기능 업데이트
• Fix (페이지 경로 또는 컴포넌트) : 버그 또는 에러 수정
• Style: 코드 스타일 수정( 포맷, 공백, 빼먹은 세미콜론, 함수 이름 변경, 줄간격 수정)
• Design: Css등 디자인 추가/수정
• Refactor: 코드 리팩토링(더 효율적인 코드로 변경)
• Remove : 코드, 파일, 주석 등을 삭제한 경우
• Test: 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 제외)
• Comment : 필요한 주석 추가 및 변경
• File : 파일 이동 또는 제거, 파일명 변경
• Chore: 이외 기타 사항. 빌드 업무 수정, 패키지 매니저 수정, 환경변수 설정
• Docs: 문서 수정(README.md 등 문서)

태그

어떤 수정 사항이 있었는지 간단하게 알 수 있도록 한다. 첫 글자는 대문자로 작성하며

종류는 다음과 같다.

• Fix(고침)
• Add(추가)

제목

제목은 코드 변경 사항에 대한 짧은 요약을 나타낸다. 제목은 다음의 규칙을 지킨다.

1. 총 글자 수는 50자 이내로 작성한다.
2. 마지막에 특수문자는 삽입하지 않는다. ex) 마침표(.), 느낌표(!), 물음표(?)
3. 제목은 서술형 문장이 아니라, 간결하고 요점적인 서술로 핵심 작성.

// 타입 : 태그 + 제목
Feat: Add get data api 함수

 

 

출처

https://overcome-the-limits.tistory.com/entry/협업-협업을-위한-기본적인-git-커밋컨벤션-설정하기

https://doooodle932.tistory.com/180