우테코 프리코스 1주차를 진행하며 깃 커밋 컨벤션에 대해서 알게 되었다.
사용하기 전에 정리하면 좋을 것 같아서 노션에 정리한 내용을 바탕으로 글을 작성하게 되었다.
깃에 커밋은 100번은 넘게 해봤지만 팀원들과 내가 알아볼 수 있을 정도면 될 것 같아서 크게 신경을 쓰지 않았는데, 컨벤션이 있다는 것에 놀랐다.
그리고 있다면 좋을 것 같은 생각은 했었는데 우테코 프리코스를 진행하며 알게 되어서 뿌듯하다.
커밋의 기본적인 틀은 아래와 같다.
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>Type
type은 아래의 리스트 중 하나를 선택하여 사용하면 된다.
- feat : 새로운 기능 구현
- fix : 버그 수정
- docs : 문서 수정
- style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
- refactor : 리팩토링
- test : 테스트 코드, 리펙토링 테스트 코드 추가
- chore : 빌드 업무 수정, 패키지 매니저 수정
Scope
scope는 커밋 변경 장소를 지정하는 모든 것이 될 수 있다.
예를 들어 $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView 등
Subject
- 제목은 최대 50자
- 문장의 끝에 마침표X
- 과거시제X
- 명령어로 작성
Body
커밋 본문 내용은 선택사항이기 때문에 모든 커밋에 본문 내용을 작성할 필요는 없다.
타이틀 외에 추가적으로 정보를 전달하고 싶을 경우에만, 본문에 추가적인 정보를 기입한다.
Footer
본문과 같이 선택 사항이며 보통 이슈를 추적하기 위해 이슈 ID를 넣어주는 용도로 사용한다.
참고참고 : https://gist.github.com/stephenparish/9941e89d80e2bc58a153
코딩하는 감자