git-commit convention

 

git을 쓰는 이유는 다양하지만 역시 버전관리와 협업이 그 중 가장 큰 비중을 차지할 것이다.

따라서 버전관리와 협업에서 도움을 주기위해선 commit message를 공들여 만들 필요가 있다.

 

function을 바꾸고 commit message에 ''function change' 라고만 적으면 무슨 함수를, 어떻게 바꿨는지 전혀 티가 나지 않기 때문에 협업에도 안좋고 심지어 혼자하는 프로젝트여도 시간이 지나면 내가 뭐 한건지 알 수가 없다.

 

따라서 commit message 쓸 때 이렇게 작성하자! 라는 convention이 존재한다.

물론 회사마다, 팀마다 약간의 차이는 있겠지만 습관으로 익혀두면 어딜 가서든 금방 적응할 수 있을 것이다.

 

1. 머리말을 쓰자.

 

머리말은 분류를 나타낸다.

내가 하는 이 작업이 어떤 작업인지를 명시해주는 것이다.

대표적으론 아래와 같은 상황이 있다.

• feat: 기능 개발
• fix: 오류 개선, 버그 패치
• docs: 문서화 작업
• test: 테스트
• conf: 환경설정
• build: 빌드
• refactor: 리팩터링

 

등등 상황에 맞게 머리말을 작성하는 것만으로 가시성이 엄청 높아진다.

 

머리말을 설정한 commit

 

2. 내용도 작성하자.

 

머리말을 포함한 제목을 작성했다면 그 내용을 자세히 적어주는 것이 좋다.

 

commit 제목과 내용

끝이다.

굉장히 쉽지만 귀찮아서 실천하기가 생각보다 어렵다.

하지만 습관화해서 commit 까지 이쁘게 해야겠다.