제목을 보자마자 이끌려서 들어가게 된 글이다.
팀 프로젝트 경험이 많지는 않다보니 그다지 커밋 메시지에 크게 신경쓰지는 않았는데
이 참고해서 미리미리 습관을 잘 들여놓아야겠다...
1.일단 커밋 메시지를 잘 작성해야하는 이유는 ?
- 커뮤니케이션 효율성 증대 : 당연하겠지만 좋은 주석이 다른 개발자와 커뮤니케이션을 돕듯이 커밋 메시지도 똑같은 역할을 한다.
- 문제 해결 속도 향상 : 특히 디버깅에서 빛을 발한다. 언제 어디서 문제가 발생했는지 쉽게 알 수 있다.
- 문서 역할 가능 : 이 기능은 프로젝트를 처음 접하거나 프로젝트에 신속하게 적응해야 하는 개발자에게 특히 유용할 수 있습니다.
2. 어떻게 좋은 커밋 메시지를 작성할 수 있는가 ?
1. 앞단에 어떤 내용을 담은 커밋인지 커밋 유형을 지정합니다.
다음은 자주 사용되는 커밋 유형이다.
- Feat: 특정 애플리케이션에 추가하는 새로운 기능
- Fix : 버그 수정
- Style : 코드 포맷팅, 코드 오타, 함수명 수정 등 스타일 수정
- Refactor : 코드 리팩토링(똑같은 기능인데 코드만 개선)
- Comment: 주석 수정 및 삭제
- Docs : 문서와 관련된 모든 것
- Chore : 정기적인 코드 유지 관리
2. 다른 사람을 배려하기 위해서 자세하게 커밋 메시지를 작성합니다.
이때 commit body를 사용하면 세부적인 내용을 적을 수 있습니다.
=> 따라서 커밋을 되게 자주자주 하는 습관을 들여야한다. 커밋량이 늘어나면 세부적인 내용이 늘어나게 되고 가독성과 디버깅 효율이 떨어질 것이다.
3. 커밋 메세지는 명령하거나 요청하는 어조를 사용
=>명령이나 요청의 어조는 시선을 끄는 역할을 할 것이다.
4. 불필요한 구두점 제거합니다.
=> 이것의 이유는 잘 모르겠다.. 아시는 분 있으면 댓글좀 부탁드린다.
5. 팀에서 정의한 '커밋 컨벤션'을 따릅니다.
커밋 컨벤션이란 ?
더보기
git 커밋 메시지 컨벤션(Git Commit Message Convention)이란 프로젝트 참여자들이 일관된 형식의 커밋 메시지를 작성하기 위한 규칙을 말합니다. 현재 여러 개발자 사이에서 관습적으로 통용되는 가이드라인이 있지만, 각 프로젝트에 따라서 별도의 규칙을 만들어 적용하기도 합니다.
예를들어 해당하는 내용에 아래의 이미지를 사용하는 것이다.
이는 가독성의 크게 도움이 될 것이다!! 물론 일괄적으로 사용을 한다는 가정하에 말이다.
✨Feat(페이지 경로 또는 컴포넌트): 새로운 기능 추가 또는 기능 업데이트
🔨Fix(페이지 경로 또는 컴포넌트): 버그 또는 에러 수정
⭐️Style(페이지 경로 또는 컴포넌트): 코드 포맷팅, 코드 오타, 함수명 수정 등 스타일 수정
🧠Refactor(페이지 경로 또는 컴포넌트): 코드 리팩토링(똑같은 기능인데 코드만 개선)
📁File(페이지 경로 또는 컴포넌트): 파일 이동 또는 제거, 파일명 변경
🎨Design(페이지 경로 또는 컴포넌트): 디자인, 문장 수정
🏷Comment(페이지 경로 또는 컴포넌트): 주석 수정 및 삭제
🍎Chore: 빌드 수정, 패키지 추가, 환경변수 설정
📝Docs: 문서 수정, 블로그 포스트 추가
🔥Hotfix: 핫픽스 수정
