Commit Convention

깃 레포지토리를 팀원들과 같이 작업을 진행할 때 각자의 가지고 있던 커밋 양식을 통일하기 위해 커밋 컨벤션을 지정하기로 했다. 지정된 커밋 컨벤션은 다음과 같다. 해당 규칙을 기준으로 커밋을 작성하기로 하였으며 이를 통해 커밋 관리를 진행하려고 한다. 커밋 컨벤션을 통해 얻고자하는 것은 다음과 같다.

지정된 커밋 양식을 통한 커밋 형식 통일화
이슈번호 #n을 지정하여 해당 이슈와 관련된 어떤 작업을 진행하였는지 파악
진행된 커밋 및 커밋의 옵션을 통해 커밋의 작업 내용을 직관적으로 파악

Commit & Type Option

type(<scope>): <subject>  -- 헤더(필수) // 주제는 50자 이하,수행한 작업에 대해 명령형 작성
 
<body>                    -- 본문(옵션) // 커밋이 설명 및 문단이 필요할 때 사용

<footer>                  -- 바닥글(옵션) // 옵션 및 이슈의 아이디를 사용

fix(<Like>): 싫어요 음수로 내려가는 오류 수정

좋아요&싫어요 번갈아가며 클릭시 음수로 내려가는 오류 수정.
좋아요는 이상 없음.

Resolves: #13 (이슈번호)

타입에 들어가는 옵션은 다음과 같이 9개로 구성되어있다.

feat : 새로운 기능
fix : 버그 수정
docs : 문서 수정
style : 코드 스타일 혹은 포맷 등에 관해서.. 코드의 변경X
refactor : 코드 리팩토링
test : 테스트 코드 추가 혹은 리팩토링.. 코드의 변경X
chore : 그 외 자잘한 수정(패키지 매니저 구성, 빌드 작업 업데이트).. 코드의 변경X
build : 빌드 관련 파일 수정
ci : CI관련 설정 수정

Commit Convention - GraduationDku/tastyHub GitHub Wiki

Commit Convention

Commit & Type Option

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️