230324 Today I Learned

클론코딩 프로젝트 시작. 번개장터 웹페이지를 클론코딩하기로 결정했다. 오늘 TIL에는 깃에 커밋할때 써야하는 형식을 써보려한다. 커밋 메시지를 별 생각없이 작성했었는데 그러다 보니 프로젝트가 끝나고 알아보기 힘들었다. 앞으로는 아래의 메시지 컨벤션을 지켜보려 한다.

---

git commit Message Convention

예시

Feat: "추가 회원가입 API"

회원가입 API 개발

Resolves: #32
Ref: #12
Related to: #25, #21

참고 사이트
참고 사이트2

구조

• 기본 구조

  Type: Subject (제목)
  (한 줄 띄우기)
  Body (내용)
  (한 줄 띄우기)
  Footer (꼬리말)

• Type

Tag Name	Description
Feat	새로운 기능을 추가
Fix	버그 수정
Design	CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor	프로덕션 코드 리팩토링
Comment	필요한 주석 추가 및 변경
Docs	문서 수정
Test	테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음
Chore	빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우

• "제목"
  : 50글자 이내. 처슬자는 대문자. 마침표나 특수문자 x
  요점만 간결하게 쓰고 과거시제x 영어일경우 동사원형을 가장 먼저

• 내용
  : 한 줄 당 72자 이내 양에 구애 받지 않고 최대한 상세히.
  어떻게 보다 무엇을 왜 변경했는지가 중요

• 꼬리말
  : optional. 이슈에 대한 내용을 작성. 유형: #이슈번호, #이슈번호

• 꼬리말 유형
  Fixes: 아직 수정중
  Resolves: 이슈 해결완료
  Ref: 참고 이슈
  Related to: 해당 커밋에 관련된 이슈 번호(미해결일 경우)

그외 깃 이모지 관련은 여기참고