Skip to content

Commit Guide

Heera Kim edited this page Mar 8, 2020 · 3 revisions

✅ tcp-web 's 커밋 가이드

📐 커밋 규칙

  • 유의미한 최소한의 기능의 단위로 커밋을 작성한다.
  • 모든 커밋은 빌드 및 동작 가능한 상태를 유지해야 한다.
  • 얽매일 필요는 없다.

⌨️ 메세지 작성 규칙

  1. 50자 이내의 제목과 빈 줄 하나, 그리고 설명문으로 구성한다.
  2. 제목에 마침표를 적지 않는다.
  3. 본문은 반드시 작성한다.
  4. 본문은 어떻게 보다 무엇을 , 에 맞춰 작성한다.
  5. prefix는 영어를 사용하며, 나머지는 한글을 사용한다.

🕋 커밋 메세지 구조

    [타입] #이슈번호 이것은 제목입니다 
    
    이것은 본문입니다.이것은 본문입니다.이것은 본문입니다.
    이것은 본문입니다.이것은 본문입니다.이것은 본문입니다.
    이것은 본문입니다.이것은 본문입니다.이것은 본문입니다.
    

🧩 커밋 타입

|============================ |feat | 새로운 기능 추가 |fix | 버그 수정 |refactor | 코드 리팩토링 |docs | 문서 작업 |chore | 의존성 추가 등 기타 사소한 수정 |test | 테스트 코드 추가 |============================

📌 참고

https://djkeh.github.io/articles/How-to-write-a-git-commit-message-kor/[좋은 git 커밋 메시지를 작성하기 위한 8가지 약속]

http://blog.naver.com/PostView.nhn?blogId=tmondev&logNo=220763012361[Git, 가장 쉽게 사용하기 - (2) commit, branch 전략 잘 짜는 법]