GIT Commit message 작성법

임태빈·2022년 7월 30일
0

Git Commit Message 규칙 정하기

커밋 메시지 타입

  1. FEATURE - 새로운 기능에 대한 커밋
  2. UPDATE - 코드에 대한 간단한 수정 (버그 x, 리펙토링 x)
  3. CHORE - 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)
  4. REFACTOR: 코드 리펙토링에 대한 커밋
  5. TEST - 테스트 코드 작성 및 수정에 대한 커밋
  6. FIX - 버그 수정에 대한 커밋
  7. TEST - 테스트 코드 작성 및 수정에 대한 커밋
  8. STYLE - 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
  9. DOCS - 문서 수정
  10. CI - CI 관련 파일 수정에 대한 커밋
  11. BUILD - 빌드 관련 파일 수정에 대한 커밋

커밋 메시지 작성법

  1. 커밋 타입 지정

  2. 제목과 본문을 빈 행으로 분리

    1. 커밋 메시지 분리 방법 확인하기(git bash 사용시에만)

    [Git] 깃 커밋 메시지 작성법(git commit message) - 2 (에디터 활용)

  3. 제목은 50자로 제한

  4. 제목의 첫글자는 대문자로 시작하기

  5. 제목 맨 마지막 글자는 마침표 사용하지 않기

  6. 제목에 내용은 명령문으로 작성하기

    1. Add CreateToken for Jwt
  7. 본문은 72자마다 끊어 줄을 바꿔준다.

  8. 본문을 사용하여 변경 한 내용과 이유 설명(어떻게 보다는 무엇과 왜를 설명한다)

  9. 검토자가 원래 문제가 무엇인지 이해한다고 가정하지 말고 확실하게 설명 추가

profile
golang과 서버 개발을 하고 있는 개발자입니다.

0개의 댓글