Git Commit Convention 우아한테크코스 프리코스를 진행하며

이번 우아한테크코스 6기 프리코스를 진행하며

제출하는 기준을 알아보던 중 github에 commit을 할때

협업을 위해 무엇을 커밋한건지 알아보기 편하고 정갈되어 보이기 위해 사용한다는 것을 알게 되었다.

 

메시지의 구성을

<타입>(<범위>): <설명>

의 형태로 올리게 되는데

 

먼저 <타입>은 코드의 내용이 기능 추가, 버그 수정 등 어떠한 commit인지 적게된다.

 

feat: 새로운 기능 추가
fix: 버그 수정
docs: 문서 변경
style: 코드 스타일 변경 (들여쓰기, 포맷팅 등)
refactor: 코드 리팩토링
test: 테스트 코드 추가 또는 수정
chore: 빌드, 패키지 관리 등과 같은 일상적인 작업

등이 있으며 한글로 작성할 수도 있다.

 

(<범위>)에는 커밋이 미치는 코드의 범위를 적는다. 이를 적는 내용은 팀마다 다를 수 있다.

 

마지막으로 <설명>은 내용을 적으며 앞의 타입에 대한 자세한 설명을 적게된다.

 

 

예시를 보여주자면

 

이렇게 나타낼 수 있다.

 

확실히 이렇게 commit을 작성하니 보기 편하고 어떤것이 변경되었는지 쉽게 알 수 있었다.