Conventional Commits

lbr·2022년 6월 30일
0

Git Commit 메세지 작성법

  1. commit의 제목은 commit을 설명하는 하나의 구나 절로 완성.
  2. importanceofcapitailize Importance Of Capitailize
  3. prefix 꼭 달기
    - feat : 기능 개발 관련
    - fix : 오류 개선 혹은 버그 패치
    - docs : 문서화 작업
    - test : test 관련
    - conf : 환경설정 관련
    - build : 빌드 관련
    - ci : Continuous Integration 관련

commit 할 때 기억해야 할 것

  • commit은 동작 가능한 최소단위로 자주 할 것.
  • 해당 작업단위에 수행된 모든 파일 변화가 해당 commit에 포함되어야 함.
  • 모두가 이해할 수 있는 log를 작성할 것.
  • Open Source Contribution시 영어가 강제되지만, 그렇지 않을 경우 팀 내 사용 언어를 따라 쓸 것.
  • 제목은 축약하여 쓰되(50자 이내), 내용은 문장형으로 작성하여 추가설명 할 것.
  • 제목과 내용은 한 줄 띄워 분리할 것.
  • 내용은 이 commit의 구성과 의도를 충실히 작성할 것.

0개의 댓글