[Git] Conventional Commits 커밋 메세지 작성법!

yeoj1n·2021년 4월 8일
0

Today I Learned

목록 보기
4/4

Conventional Commits 1.0.0

구조

  • fix: 버그 패치
  • feat: 기능 추가
  • BREAKING CHANGE: 큰 변화 (본문이나 꼬리말의 시작 부분에 나타냄)
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

예제

feat: 새로운 기능 추가
fix: 버그수정
docs: 문서 수정
style: 코드 스타일 수정(코드스타일 수정
refactor: 리팩토링
test: 테스트 추가/수정
chore: 태스크 러너(축소화, 유닛 테스트, 린트) 업데이트이트

참고: Git Commit Msg

  1. Description + 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
  1. 내용 없는 커밋
docs: correct spelling of CHANGELOG
  1. 적용 범위를 가지는 커밋
feat(lang): add polish language
  1. 옵션 이슈 번호를 가진 버그 수정 커밋
fix: correct minor typos in code

see the issue for details

on typos fixed.

Reviewed-by: Z
Refs #133

왜 커밋 컨벤션을 사용해야할까?

  • CHANGELOG를 자동으로 생성하기 위해서
  • (포함된 커밋의 타입에 기반하여) 유의적 버전을 자동으로 변경하기 위해서
  • 팀 동료, 타인, 그리고 기타 이해당사자에게 변화의 본질을 전달하기 위해서
  • 빌드와 배포 프로세스를 수행하기 위해서
  • 구조화된 커밋 히스토리를 보여줘서 사람들이 프로젝트에 기여하기 더 쉽도록 하기 위해서

현재 회사에서 Conventional Commits을 사용하고 일감 번호가 눈에 더 잘 띄도록
feat(#일감번호): description
형태를 사용하고있는데 이와 같이 사용하니 적용 범위를 적을 공간이 사라졌다...
기본적인 convention을 따르며 업무에 맞게 수정하여 형태를 만들어나가는 것도 좋은 방법인 것 같다. :-)

profile
기록남기기👩‍💻

0개의 댓글