최근 팀 프로젝트를 하면서 Git을 본격적으로 사용하게 되었고, 커밋 메시지를 언제, 어떻게 작성해야 하는지 참 어렵게 느껴졌다.
혼자 프로젝트를 할 땐 늘 "아 오늘은 여기까지! 커밋!" 하루 작업 단위로만 커밋을 진행했다.
작업 내용이 명확하게 드러나지 않고, 무슨 작업이었는지 나조차도 기억하기 힘들었다.
그래서 나는"커밋 메시지, 이제는 아무렇게나 쓰면 안 되겠다."는 생각이 들었고,그동안 배운 것들을 정리해보려 한다.
📌 왜 커밋 메시지가 중요할까?
- 코드 히스토리 추적이 쉬워짐
- 협업 시 변경 내용 이해가 쉬움
- PR 리뷰, 디버깅 효율 증가
좋은 커밋 메시지는 프로젝트의 유지보수성을 높이고, 개발 팀 내에서의 협업을 강화하는 데 기여한다.
따라서 커밋 메시지 작성은 단순한 기록을 넘어서 프로젝트 관리의 핵심 요소로 간주된다.
📌 커밋 메시지 작성의 기본 원칙
- 명확하고 간결해야 한다 → 불필요한 정보는 제외하고, 변경 사항을 명확하게 설명해야 한다.
- 변경 사항의 이유를 포함해야 한다 → 왜 그런 변경이 필요했는지를 설명해야 한다.
- 일관된 형식을 유지 → 커밋 메시지의 형식을 표준화하여, 모든 팀원이 동일한 방식으로 메시지를 작성할 수 있도록 해야 한다.
- 가능한 한 구체적으로 → 변경 사항의 세부 사항을 포함하여, 나중에 찾아볼 때 쉽게 이해할 수 있도록 해야 한다.
커밋 메시지의 품질을 높이고, 프로젝트의 히스토리를 보다 효과적으로 관리하는 데 도움이 된다.
📌 커밋 메시지 규칙 예시 (Conventional Commits)
feat | 새로운 기능 추가 |
fix | 버그 수정 |
docs | 문서 관련 변경 |
style | 코드 포맷팅 (공백, 세미콜론 등) |
refactor | 기능 변경 없는 코드 리팩토링 |
test | 테스트 코드 추가 |
chore | 빌드, 패키지 등 기타 잡다한 작업 |
📌커밋 메시지 자동화 도구
- `commitizen`: 커밋 메시지 템플릿 선택 도와줌
- `cz-customizable`: 커스텀 옵션 가능
- `husky + lint-staged`: 커밋 전에 lint 검사
아직도 나는 미흡한게 많지만, 지금부터라도 기록하는 개발자가 될 수있게 노력해야겠다.
커밋 메시지는 단순히 남기는 게 아니라, 코드에 대한 의도를 기록하고, 협업의 흐름을 만들어가는 소통의 도구다.
'IT 알쓸신잡' 카테고리의 다른 글
웹 렌더링 방식: CSR과 SSR (0) | 2025.04.11 |
---|---|
굳바이 styled-components😢 (0) | 2025.04.01 |
모노레포 접근법 (0) | 2025.03.19 |
프로그래밍 언어와 기술 ? (0) | 2025.03.04 |
사용자 / 클라이언트 / 서버 (0) | 2025.02.19 |