Git 커밋 베스트 프랙티스 (Git commit best practice)

in #git7 years ago

Git 커밋 베스트 프랙티스

  1. 제목과 본문을 한 줄 띄워 분리하기
    a. 가독성 향상
    b .제목 리스트만 조회 가능 (git log --oneline, git shortlog)
    c. 상세 설명 확인 용이
    d. 제목만 잘 써서 본문 필요없으면 베스트
  2. 제목은 영문 기준 50자 이내로 (한글은 25자?)
  3. 제목 첫글자를 대문자로 : 글로벌 프로젝트라면 필수
  4. 제목 끝에 . 삼가
  5. 제목은 명령조로
    a. git revert => Revert "Add the thing with the stuff"
    b. Merge branch 'myfeature'
    c. git의 빌트-인 컨벤션(Built-in Convention)을 따르자
    d. If applied, this commit will {제목}
  6. 본문은 영문 기준 72자마다 줄 바꾸기
  7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

예제:

  • 리팩토링할때 : Refactor function call for optimisation
  • 단순 주석을 달때: Add comments for readability
  • 버그 수정: Fix rememberme bug

더 많은 예제들:

  • 가독성을 위해 서브시스템 X를 리팩토링한다 (Refactor subsystem X for readability)
  • Getting Started 문서를 갱신한다 (Update getting started documentation)
  • Deprecated된 메소드를 삭제한다 (Remove deprecated methods)
  • 버전 1.0.0으로 판올림한다 (Release version 1.0.0)

주로 쓰일 제목의 시작 단어들:

  • Add (신규개발)
  • Fix (버그수정)
  • Refactor (로직개선)
  • Update (로직수정)
  • Remove (로직삭제)
  • Release (릴리즈)
  • Minor (로직에 영향을 주지 않는 변경 e.g. 줄바꿈, 줄맞춤, 주석정리, 오타수정 등등)