📝
Git 커밋 메시지의 중요성
June 09, 2023
Git 커밋 메시지는 왜 중요할까
잘 만든 커밋 메시지는 다른 개발자에게 변경 사항을 전달하는 가장 쉽고 간편한 방법이기 때문입니다. 그래서 기업의 대규모 프로젝트는 당연하고 협력의 비중이 낮은 소규모의 사이드 프로젝트에서도 커밋 컨벤션을 따로 만들어서 규칙을 지키기도 합니다.
커밋 컨벤션이란?
git 커밋 메시지 컨벤션(Git Commit Message Convention)이란 프로젝트 참여자들이 일관된 형식의 커밋 메시지를 작성하기 위한 규칙을 말합니다. 현재 여러 개발자 사이에서 관습적으로 통용되는 가이드라인이 있지만, 각 프로젝트에 따라서 별도의 규칙을 만들어 적용하기도 한다고 합니다.
커밋 메시지를 왜 사용할까요?
git에서 변경 사항을 저장하기 전에 수많은 변경 사항을 적용했을 수 있으므로 저장할 변경 사항을 git에 알려야 합니다. 가장 좋은 방법은 커밋 메시지를 추가하여 변경 사항을 식별하는 것이기 때문에 커밋 메시지를 사용합니다.
커밋 메시지를 잘 작성해야 하는 이유는 무엇인가요?
- 커뮤니케이션의 효율성 증대
- 일관적이고 명확한 커밋 메시지는 다른 개발자가 더 쉽게 이해하도록 돕기 때문에
서로의 작업에 대한 이해도를 높이고 프로젝트 관리와 협업에 중요한 역할을 합니다.
- 문제 해결 속도 향상
- 시간이 지남에 따라 코드베이스는 매우 복잡해질 수 있습니다.
적절한 커밋 메시지 규칙은 메인테이너가 코드를 이해하는 데 도움이 되며
향후 변경 사항을 더 쉽게 만들 수 있습니다. 또 문제를 더 쉽게 디버깅할 수 있고 문제가 발견되면
개발자는 커밋 메시지를 사용하여 언제 어디서 문제가 발생했는지 식별할 수 있다는 장점이 있습니다.
- 문서화의 기능
- 적절한 커밋 메시지 규칙은 코드베이스 변경 내역을 제공하는 문서 역할을 할 수 있습니다.
잘 만든 git 커밋 메시지는 해당 프로젝트에서 작업하는 다른 개발자와 미래의 자신에게
변경 사항을 전달하는 가장 좋은 방법입니다.
커밋 메세지 작성법
- 앞단에 어떤 내용을 담은 커밋인지 커밋 유형을 지정합니다.
- Feat: 특정 애플리케이션에 추가하는 새로운 기능
- Fix : 버그 수정
- Style : 코드 포맷팅, 코드 오타, 함수명 수정 등 스타일 수정
- Refactor : 코드 리팩토링(똑같은 기능인데 코드만 개선)
- Comment: 주석 수정 및 삭제
- Docs : 문서와 관련된 모든 것
- Chore : 정기적인 코드 유지 관리-
다른 사람을 배려하기 위해서 자세하게 커밋 메시지를 작성합니다. 이는 동료 개발자가 변경 사항을 더 잘 이해하는데 도움됩니다.
-
커밋 메세지는 명령하거나 요청하는 어조를 사용합니다.
-
불필요한 구두점 제거합니다.
-
팀에서 정의한 ‘커밋 컨벤션’을 따릅니다.