[Git]Commit Message Convention

HW·2023년 4월 21일
0

Git

목록 보기
3/3

서론

Git 기능 중 하나가 커밋(Commit)입니다.
커밋 메시지는 Git으로 작성한 코드의 변경 사항을 명확하게 기록하는 데
중요한 역할을 합니다.
이번 글에서는 Git 커밋 메시지를 작성할 때 고려해야 할 사항과
작성 방법에 대해 알아보겠습니다.

본론

명령조 사용

  • 🎉INIT : Initial Commit
  • 🎈RELEASE : 릴리즈 버전 출시
  • 🚨BREAKINGCHANGE : 커다란 API 변경
  • 🔥HOTFIX : 치명적인 긴급한 버그 (급하게 버그를 고쳐야 하는 경우)
  • ✨FEAT : 새로운 기능의 추가
  • 🃏EXCEPTION : 예외처리
  • 🐛BUG : 버그 리포트
  • 🚑FIX : 버그 수정
  • 📰FILE : 새로운 파일 추가
  • 🐎TUNE : 성능 향상
  • 💩POOP : 개똥같이 쓴 코드
  • 👷BUILD : 빌드 관련 파일 수정
  • 📺DESIGN : CSS, UI 변경
  • 💄STYLE : 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 로직 변경이 없는 경우)
  • 🔬SCOPE : 코드 범위 추가
  • 🎨REFACTOR : 코드 리펙토링
  • 🚜DIRECTORY : 폴더 구조 변경
  • 📝DOCS : 문서 수정
  • 🛢️DB : 데이터 베이스
  • 🔒SECURE : 보안 관련 수정
  • ✍️COMMENT : 주석 추가
  • 💡IDEA : 새로운 아이디어
  • 🤝MERGE : 파일 병합
  • 👽EXTERNAL : 외부 변화로 인한 수정
  • ⏳RESUMPTION : 오랜 기간이 지난 후 작업 재개
  • ✅TEST : 테스트 코드, 리펙토링 테스트 코드 추가
  • 💚CI : CI 관련 설정 수정
  • ⚙️CONFIG : 의존성 관리, 개발 환경에 관련된 작업
  • 🔨CHORE : 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)
  • 🐳DOCKER : 도커 구성
  • ➕ PLUS : dependency 추가
  • ➖ MINUS : dependency 제거
  • 🔊 LOGUP : 로깅을 추가할 때
  • 🔊 LOGDOWN : 로깅을 줄일 때

결론

Git 커밋 메시지는 코드 변경 사항을 명확하게 기록하는 데 중요한 역할을 합니다.
제목 줄과 본문으로 나누어 작성하며,
명령어를 사용하여 요약하고 자세한 내용을 작성합니다.
이슈 번호를 참조하는 것도 좋은 방법입니다.

profile
예술융합형 개발자🎥

0개의 댓글