Git과 GitHub(4) - Git Commit Convention

Jun_Gyu·2023년 7월 13일
0
post-thumbnail

Git Commit Convention

= 커밋 메세지
커밋 메세지를 통해 어떤 개발인지, 어떤 수정사항이 있는지 파악이 가능.

ex)
Feat: "암호화 알고리즘 추가"               - [제목]

비밀번호 암호화를 위한 암호화 알고리즘 추가   - [본문]

Closes: #33                            - [꼬리말]

일반적인 커밋 메세지 작성 명령어

$ git commit -m "Feat: 작업내용"

vim 편집기 이용 명령어

(편집기 내에서 제목, 본문, 꼬리말 작성 가능.)

$ git commit

보통 총 7가지 메세지 규칙을 지킨다.

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

(출처: https://cbea.ms/git-commit/)


제목

Feat: "암호화 알고리즘 추가"
  1. 50자 이내
  2. 시작할 때는 대문자로 시작 (보통 Fix, Add, Change 등의 명령어로 시작)
  3. 마칠 때 마침표 등의 특수문자 없이 작성
  4. 개조식으로 작성
  5. 타입: 내용” 의 형식으로 작성

타입의 경우 여러가지를 지정 가능.

Feat : 새로운 기능 추가
Fix : 버그 수정
Env : 개발 환경 관련 설정
Style : 코드 스타일 수정 (세미 콜론, 인덴트 등의 스타일적인 부분만)
Refactor : 코드 리팩토링 (더 효율적인 코드로 변경 등)
Design : CSS 등 디자인 추가/수정
Comment : 주석 추가/수정
Docs : 내부 문서 추가/수정
Test : 테스트 추가/수정
Chore : 빌드 관련 코드 수정
Rename : 파일 및 폴더명 수정
Remove : 파일 삭제

본문

비밀번호 암호화를 위한 암호화 알고리즘 추가
  • 한 줄 당 72자 이내
  • 아무리 길어도 괜찮으니, 최대한 상세히 작성
  • 무엇을, 변경했는지 작성 (코드 자체를 상세히 적는 것은 X)

꼬리말

Closes: #33
  1. 꼬리말은 선택사항. (없어도 무방)
  2. "유형: 이슈번호" 형식으로 작성
  3. 유형Close, Fix, Resolve 등을 활용
    (보통 Close 는 일반 개발 이슈를 닫을 때, Fix 는 버그 이슈를 닫을 때, Resolve 는 문의나 요청사항에 대한 이슈를 닫을 때 사용)
profile
시작은 미약하지만, 그 끝은 창대하리라

0개의 댓글