12. git commit convention 정하기

지구·2023년 7월 17일
0

Git, Github 정리

목록 보기
15/19

7가지 메세지 규칙

보통 총 7가지 메세지 규칙을 지킨다. (출처: https://cbea.ms/git-commit/)

  1. 제목과 본문은 한 줄을 띄워서 작성한다.
  2. 제목은 영문 기준 50자 이내로 작성한다.
  3. 제목 첫글자는 무조건 대문자로 작성한다.
  4. 제목 끝에 마침표(.)는 찍지 않는다.
  5. 제목은 개조식 (영어라면 명령문) 으로 작성한다. (Update code, Fix bug 등으로만 작성, 만약에 한글로 작성한다면 ‘abc 함수 수정’ 과 같은 식으로)
  6. 본문은 영문 기준 72자마다 줄바꿈을 한다.
  7. 본문은 무엇을, 에 맞춰서 작성한다.

커밋 타입

타입설명
Feat새로운 기능을 추가할 경우
Fix버그를 고친 경우
Env개발 환경 관련 설정
DesignCSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE커다란 API 변경의 경우
!HOTFIX급하게 치명적인 버그를 고쳐야하는 경우
Style코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor프로덕션 코드 리팩토링
Comment필요한 주석 추가 및 변경
Docs문서를 수정한 경우
Test테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove파일을 삭제하는 작업만 수행한 경우

본문

  1. 한 줄 당 72자 이내
  2. 아무리 길어도 괜찮으니, 최대한 상세히 작성
  3. 무엇을, 왜 변경했는지 작성 (코드 자체를 상세히 적는 것은 지양)

꼬리말

Close: #123

Github 상의 이슈를 닫는 것과 관련해서, 커밋 메세지를 통해서도 이슈를 닫을 수 있다.

  1. 꼬리말은 어디까지나 선택 사항
  2. “유형: 이슈번호” 형식으로 작성
  3. 유형은 “Close, Fix, Resolve” 등을 활용
    (보통 Close 는 일반 개발 이슈를 닫을 때,
    Fix 는 버그 이슈를 닫을 때,
    Resolve 는 문의나 요청사항에 대한 이슈를 닫을 때 사용)

🎈이슈를 닫는 메세지는 본문에 작성하고도 한다.

profile
프론트엔트 개발자입니다 🧑‍💻

2개의 댓글

comment-user-thumbnail
2023년 7월 18일

정말 잘 읽었습니다, 고맙습니다!

답글 달기
comment-user-thumbnail
2023년 7월 18일

소중한 정보 감사드립니다!

답글 달기