Skip to content

커밋 메시지 정책

dahun-lee-daji edited this page May 3, 2021 · 7 revisions

Semantic Commit Messages

Basic Rule

  • 커밋 메시지는 알아보기 쉽게 한글로 작성.
  • 다만, Commit Header는 영어로 작성.

Convention

{commit header}: {commit title} (#{issue number})

Commit Header

  • feat: 신규 기능 구현 : 사용자를 위한 신 기능; 새로운 빌드 관련 기능은 미포함
  • fix: 버그나 에러 수정 : 사용자 버그 수정; 빌드 관련 버그 픽스 미포함
  • refactor: 리팩토링 : Production Code ( 비즈니스 로직 ?)의 수정사항; 변수의 이름 변경 포함.
  • style: 코드 스타일 수정 : 포멧, 잊어버린 세미 콜론 등; Production Code의 코드 변경이 없음.
  • docs: 문서 작업 : 문서의 변경점
  • test: 테스트 코드 : 빠진 테스트의 추가, 테스트의 리팩터링; Production Code의 변경 없음
  • chore: 그외 기타 : updating grunt tasks etc; Production Code의 변경 없음

커밋 메시지 자주 쓰는 동사

  • 추가(Add)
  • 수정(Update)
  • 삭제(Delete)

예시

  • refactor: Delete plus function from practice/prac03/index.js (#11)
  • style: Add practice/background.js (#13)
  • fix: Add meta property to index.html (#22)
  • docs: Update README.md (#27)
  • feat: Connect weather API (#31)

참고 링크