ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • conventional commits
    git 2024. 4. 20. 17:28

    Conventional Commits

    커밋 메시지는 다음과 같은 구조가 되어야 한다.

    <타입>[적용 범위(선택 사항)]: <설명>
    
    [본문(선택 사항)]
    
    [꼬리말(선택 사항)]

    1. commit의 제목은 commit을 설명하는 문장형이 아닌 구나 절의 형태로 작성

    2. importance of capitalize -> Importance of Capitalize'

    3. prefix 꼭 달기 -> 위의 구조에서 <타입>에 해당(breaking change가 있다면 type뒤어 !)

    - feat: (feature) 기능개발 관련

    - build: 빌드 작업 관련

    - fix: 오류 개선 혹은 버그 패치

    - docs: 문서화 작업

    - test: test 관련

    - conf: 환경설정 관련

    - ci: continuous Integration 관련

    - chore: 패키지 매니저, 스크립트 등

    - style: 코드 포매팅 관련

    -----------------------------<commit message 예제>

    설명과 BREAKING CHANGE 꼬리말을 가지는 커밋 메시지

    feat: allow provided config object to extend other configs
    
    BREAKING CHANGE: `extends` key in config file is now used for extending other config files
    

    단절적 변경(breaking change)에 주의를 주기 위해 !를 포함한 커밋 메시지

    feat!: send an email to the customer when a product is shipped
    

    단절적 변경(breaking change)에 주의를 주기위해 적용 범위와 ! 를 포함한 커밋 메시지

    feat(api)!: send an email to the customer when a product is shipped
    

    BREAKING CHANGE 꼬리말과 !를 함께 포함한 커밋 메시지

    chore!: drop support for Node 6
    
    BREAKING CHANGE: use JavaScript features not available in Node 6.
    

    본문이 없는 커밋 메시지

    docs: correct spelling of CHANGELOG
    

    적용 범위를 가지는 커밋 메시지

    feat(lang): add polish language
    

    다중-단락 본문과 다수의 꼬리말을 가진 커밋 메시지

    fix: prevent racing of requests
    
    Introduce a request id and a reference to latest request. Dismiss
    incoming responses other than from latest request.
    
    Remove timeouts which were used to mitigate the racing issue but are
    obsolete now.
    
    Reviewed-by: Z
    Refs: #123

    'git' 카테고리의 다른 글

    간단한 mark down 문법 사용예  (0) 2024.04.21
    github + hexo blog + next theme  (0) 2024.04.21
    wsl + github 사용하기 1  (0) 2024.04.20
    WSL ubuntu에서 git 사용하기  (1) 2024.04.19
    conventional commit summary  (0) 2024.04.19
Designed by Tistory.