본문 바로가기
코딩 공부/Git

Git Commit - 효과적인 커밋 메시지 작성법

by JH-M 2023. 5. 9.

Git은 개발자들 사이에서 매우 인기 있는 버전 관리 시스템입니다. Git을 통해 소스 코드를 효율적으로 관리하고 협업할 수 있습니다. 이 글에서는 Git의 핵심 기능 중 하나인 '커밋(commit)'에 대해 알아보고, 예제와 함께 효율적인 커밋 메시지를 작성하는 방법을 소개하겠습니다.

Git 커밋 예제

새로운 프로젝트를 시작하거나 기존 프로젝트에 Git을 적용하려면, 먼저 Git 저장소를 생성해야 합니다.

mkdir my_project
cd my_project
git init

예제를 위해, 새로운 파일 'README.md'를 생성하고 텍스트를 작성합니다.

echo "# 커밋하기!" > README.md

변경 사항을 스테이지에 올립니다.

git add README.md

변경 사항을 스테이지에 올린 후, 커밋을 실행합니다.

git commit -m "Add README.md"

커밋한 내역을 확인하려면 git log 명령어를 사용합니다. git log를 실행하면, 커밋한 내역이 시간순으로 출력됩니다.

git log

효율적인 커밋 메시지 작성법

커밋 메시지는 다른 개발자들이 변경 사항을 이해하기 쉽게 명확하게 작성해야 합니다. 효율적인 커밋 메시지 작성을 위한 팁은 다음과 같습니다.

  1. 제목과 본문 분리: 첫 줄에 간결한 제목을 작성하고, 한 줄 띄우고 상세한 본문을 작성합니다.
  2. 50자 이내의 제목 요약: 변경 사항을 간결하게 요약합니다.
  3. 본문의 72자마다 줄바꿈: 가독성을 위해 72자마다 줄을 바꿉니다.
  4. 영어에서는 명령문 사용: 무엇을 했는지 명령문으로 작성합니다(예: "Add login feature").
  5. 한글에서는 명사형 사용: 서술형이 아닌 담백한 명사형으로 표현합니다(예: "기능 이슈 해결").
  6. 이유와 해결 방법 설명: 변경 사항이 필요한 이유와 해결 방법을 설명합니다.

예시:

git commit -m "로그인 기능의 이슈 #123 해결

이 이슈는 인증 과정에서 잘못된 검증 방법 때문에 발생했습니다.
이 커밋에서는 보다 안전한 검증 방법으로 교체하고 관련 단위 테스트를 추가합니다."



Git 커밋은 프로젝트의 변경 사항을 기록하는 데 있어 핵심적인 역할을 수행합니다. 커밋을 통해 작업 내역을 명확하게 추적할 수 있으며, 문제 발생 시 원인을 찾아 해결하는 데 도움이 됩니다. 효과적인 커밋 메시지를 작성하는 습관을 들이면, 협업하는 다른 개발자들과 원활한 소통이 가능해지고 프로젝트 관리에 큰 도움이 됩니다.

댓글