팀원 간 일관된 커밋 메시지 작성을 위한 가이드입니다.
.gitconfig와 .gitmessage.txt를 설정하면 커밋 시 자동으로 템플릿이 적용됩니다.
- 50자 이내로 요약
- 무엇이 변경되었는지 명확히 작성
- 끝에 마침표 금지
- 예:
################
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) ✨ :: 로그인 기능 추가
✨ :: 로그인 기능 추가 <- 여기에 작성
✨ feat(login) :: 로그인 기능 추가 <- 이런식으로 작성해도 무방
# 하단 공백 필수: 제목 분리용
<- 이 공백은 건드리지 말것!
################- 변경 사항에 대한 구체적인 설명
- 여러 줄 작성 시
-로 구분 - 한 줄은 72자 이내로 작성
################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
- 필요하다면
- 이런식으로
- 한줄씩 작성하기
################- 관련된 이슈가 있다면 아래와 같이 명시
Close #이슈번호################
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) ✨ :: 로그인 기능 추가
# 하단 공백 필수: 제목 분리용
################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
################
# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
# 예) Close #7
################
# 🎉 ::
# [Init]: 프로젝트 생성
# ✨ ::
# [Feat]: 새로운 기능 구현
# 🎨 ::
# [Design]: 화면, 레이아웃 조정
# 🐛 ::
# [Fix]: 버그 해결
# ➕ ::
# [Add]: Feat 이외의 부수적인 코드, 파일
# 🗑️ ::
# [Del]: 쓸모없는 코드, 파일, 주석 삭제
# ♻️ ::
# [Refact]: 전면 수정이 있을 때
# 📝 ::
# [Docs]: README나 WIKI 등의 문서 개정
# ✏️ ::
# [Comment]: 필요한 주석 추가 및 변경
# ✅ ::
# [Test]: 테스트 코드 작성
# 🪄 ::
# [Style]: 코드 의미에 영향을 주지 않는 변경사항
# 🛠️ ::
# [Chore]: 빌드 부분 혹은 패키지 매니저 수정사항
# ⚡️ ::
# [Improve]: 향상이 있을 때
# 🔀 ::
# [Merge]: 기존 코드와 병합
# 💩 ::
# [Poop]: 똥싼코드
################touch ~/.gitmessage.txt위 템플릿 내용을 해당 파일에 붙여넣기
[user]
name = 깃허브아이디
email = 깃허브메일
[commit]
template = ~/.gitmessage.txt
[credential]
helper = osxkeychain
깃허브아이디,깃허브메일은 본인의 정보로 변경하기
git commit
# 자동으로 .gitmessage.txt 템플릿이 열립니다.
# 형식에 맞게 작성 후 저장 & 종료하면 커밋 완료!