Github

git conventional commit에 대해 살펴보기

리미에오 2023. 12. 14. 15:32
반응형

 

https://www.conventionalcommits.org/en/v1.0.0/

위의 주소로 들어가게 되면, 어떨경우에 conventional commit을 작성할 지 가이드 문서가 나와있습니다. 

대표적으로 아래 conventional commit을 쓰게 됩니다. 

 

  • fix : 무언가를 고쳤을 때
  • feat : 기능개발
  • BREAKING CHANGE : 예전의 기능이 빠그라졌을 때 사용 / 큰 바뀜이 있었을 때
  • build : 
  • chore : 잡일
  • ci : ci
  • docs : documentation작업
  • refactor : 어떤것을 개선시켰을 때
  • style : 코드 스타일 바꿀 때
  • perf : 퍼포먼스 작업했을 때
  • test : test작업 했을 때
  • lint : lint작업했을 때

예시적으로 commit을 남길 때, 앞에 머릿말 태그 느낌으로 어떤 commit이다 상태를 알리고 뒤에는 구체적으로 commit에 대한 설명을 명시하면 좋습니다.

git commit -m "lint: add a final line to the bottom of yaml files to fix the lint error"

 

보통은 "<conventional> : 보통동사 ~~~" 이런 형태로 commit을 많아합니다. 이렇게 작업하는 이유는 협업할 때 보다 명시적으로 작업하고 효율을 올릴 수 있습니다. 내가 이전 commit을 참고하고 싶은데, commit을 이렇게 명시적으로 적지 않는다면 어떤 commit인지 일일히 다 찾아야겠죠? 

반응형