commit convention

Tags
commit
설명
커밋 규칙 정의

정리 글 원문 링크

추가 참조하면 좋은 링크

 

커밋 메세지 컨벤션 정의

(1) 형식

type:subject "타입:주제" 형식으로 타이틀 작성 * 제목은 50글자를 넘기지 않고 마침표를 표시하지 않는다. * 명령어조로 커밋 내용의 핵심만 간략하게 표시 body (optional) 72글자 내외로 본문에 자세하게 풀어씀. * 어떻게(how) 구현했는지 코드설명 보다는 / 무엇을(what) 했고, 왜(why) 했는지에 초점을 맞춤. footer 이슈ID 태그 작성. (이슈 추적용)

(2) 타입 종류

  • feat: A new feature
    • 새로운 기능 추가
  • fix: A bug fix
    • 버그 수정
  • docs: Changes to documentation
    • 문서 업데이트
  • style: Formatting, missing semi colons, etc; no code change
    • 오타 수정, 문자열 형식 변경 등 ( 코드 로직은 변화 없음 )
  • refac: Refactoring production code
    • 코드 리팩토링
  • test: Adding tests, refactoring test; no production code change
    • 테스트코드 추가, 테스트코드 리팩토링
  • chore: Updating build tasks, package manager configs, etc; no production code change
    • 빌드작업 업데이트, 패키지 매니저 config 설정 변경

예시

feat: 상세페이지에 무한스크롤 추가 21.02.15 추가된 요구사항에 따라 @@컴포넌트에 무한 스크롤 기능을 추가함. - @@##** 라이브러리 추가 Resolves: #123(이슈번호) See also: #456, #789
fix:포럼탭 동일한 포럼글 무한조회 버그 수정 포럼 탭에서 기조회된 포럼글의 하위 5개가 더보기 버튼을 누를 때마다 계속 조회되던 현상을 수정함. Resolves: #123(이슈번호)