Skip to content

02_GIT Commit Message

chaeryung edited this page Dec 13, 2022 · 6 revisions

✏️ Commit Message 작성 방법

유형들이 복합적으로 포함되어 있을 경우, 되도록 커밋을 분리한다. 분리가 어려운 경우 위 순서상 상위 항목의 유형으로 작성한다. (eg. 기능과 테스트가 모두 포함된 경우 기능으로 작성)

✨ feat: 기능 추가, 삭제, 변경
🐛 fix: 버그, 오류 수정
📝 docs: readme.md, json 파일 등 수정, 라이브러리 설치 (문서 관련, 코드 수정 없음)
🎨 style: CSS 등 사용자 UI 디자인 변경 - 제품 코드 수정 발생, 코드 형식, 정렬, 주석 등의 변경
♻️ refactor: 코드 리펙토링
🧪 test: 테스트 코드 추가, 삭제, 변경 등 - 코드 수정 없음. 테스트 코드에 관련된 모든 변경에 해당
🔧 config: npm 모듈 설치 등
🌱 chore: 패키지 매니저 설정할 경우, etc 등

🔍 커밋 터미널 작성 예시

본문은 한글로 작성하고 footer에 발행한 이슈와 매치시킵니다.

# [타입] : <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
# 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성
[feat]: 로그인 기능 구현
################
# 본문(추가 설명)을 아랫줄에 작성
구글 API 활용하여 로그인 기능 구현, 본인 구글 계정으로 테스트 가능
################
# feat: 새로운 기능 구현
# fix: 오류 수정
# docs: readme.md, json 파일 등 수정 and 라이브러리 설치 (문서관련)
# refactor : 코드 리팩토링
# style: 코드에 변화가 없는 수정 (세미콜론 등)
# chore: 빌드 부분 혹은 패키지 매니저 수정사항
# rename: 파일 혹은 폴더명 수정 or 옮기기
# remove: 파일 삭제
################

✍🏻 Commit Message Example

코드
컨벤션 ✨ feat: 기능 구현 내용
예시 ✨ feat: CommonButton 컴포넌트 구현

📝 Commit Message Emoji

타입 이모지 이모지 코드 코드 수정 여부 코드 동작에 영향 설명
Initial Commit 🎉 :tada: X X 프로젝트 초기 설정
feat ✨ :sparkles: O O 기능 추가, 삭제, 변경
style 🎨 :art: O O CSS 등 사용자 UI 디자인 변경
fix 🐛 :bug: O O 버그 수정
docs 📝 :memo: X X 문서 추가, 삭제, 변경
refactor ♻️ :recycle: O O 파일구조 변경, 코드 리팩토리
test 🧪 :test_tube: X X 테스트 코드 관련 기능 추가, 삭제, 변경, 리팩토리
config 🔧 :wrench: O X 의존성 모듈 등, 코드 컨벤션 수정 (코드 형식, 정렬, 주석, 세미콜론 등 동작에 영향을 주는 변경은 없는 경우)설정
chore 🌱 :seedling: X X 설정 변경, 잡다한 업무

Clone this wiki locally