Commit 메시지 규칙은 커밋 로그 가독성, 협업 리뷰 과정, 코드 유지 보수를 위해 진짜 꼭 필요하다.

Commit Message 규칙 8개

  1. 제목 본문 한줄 띄어 분리
  2. 제목 50자 이내
  3. 제목에 마침표 금지
  4. 제목은 구문형 ex) "Somefunction 수정", 본문은 평서문
  5. 제목이 영어이면 첫번째 문자는 대문자로
  6. Github 이슈 번호 붙이기 ex) #123
  7. 본문 72자 마다 줄 바꾸기
  8. 본문은 How 보다 What, Why 에 초첨

Conventional Commits 규칙

이태릭체는 생략할 수 있습니다

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

  • type

    • feat : 새로운 기능 추가 및 수정
    • fix : 버그 픽스
    • build : 빌드 관련 파일 수정 ex) npm, yarn
    • ci : CI 설정 파일 변경
    • docs : 문서 변경
    • style : 코드 구문과 관련 없는 부분 ex) 띄어쓰기, 세미콜론
    • refactor : 리팩토링 관련 수정
    • test : 테스트 생성 및 수정
    • pref : 성능 향상 관련 코드 수정
  • scope

  • subject

    • 왜 무엇을 바꾸었는지 과거 코드와 비교해 현재 시제로 작성
  • footer

    • Breaking Changes 정보를 적는 공간, Breaking Changes는
    • 닫히는 GitHub 이슈 번호를 적음
    BREAKING CHANGE: isolate scope bindings definition has changed and
    the inject option for the directive controller injection was removed.
    
    To migrate the code follow the example below:
    
    Before:
    
    scope: {
    myAttr: 'attribute',
    myBind: 'bind',
    myExpression: 'expression',
    myEval: 'evaluate',
    myAccessor: 'accessor'
    }
    
    After:
    
    scope: {
    myAttr: '@',
    myBind: '@',
    myExpression: '&',
    // myEval - usually not useful, but in cases where the expression is assignable, you can use '='
    myAccessor: '=' // in directive's template change myAccessor() to myAccessor
    }
    
    The removed `inject` wasn't generaly useful for directives so there should be no code using it.
    Closes #234
    
    or
    
    Closes #123, #245, #992

예시

feat($browser): onUrlChange event (popstate/hashchange/polling)

Added new event to $browser:

- forward popstate event if available
- forward hashchange event if popstate not available
- do polling when neither popstate nor hashchange available

Breaks $browser.onHashChange, which was removed (use onUrlChange instead)
fix($compile): couple of unit tests for IE9

Older IEs serialize html uppercased, but IE9 does not...
Would be better to expect case insensitive, unfortunately jasmine does
not allow to user regexps for throw expectations.

Closes #392
Breaks foo.bar api, foo.baz should be used instead

브랜치명

브랜치 명은 {type}/{issue number}-{간단한 이슈 설명} 으로 한다.


Reference

'Docker, Kubernetes' 카테고리의 다른 글

쿠버네티스 deployment 업데이트 방법  (0) 2021.02.23
쿠버네티스 기본 명령어  (0) 2021.02.23
Docker 기본 명령어  (0) 2021.02.23
CI 지속적 통합  (0) 2020.12.27
브랜치 전략 패턴 git-flow, github-flow  (0) 2020.12.26

+ Recent posts