[Git] 커밋 메시지 규칙: 깔끔하고 일관된 코드 관리의 핵심

 

커밋 메시지는 소프트웨어 개발에서 중요한 역할을 합니다.

잘 작성된 커밋 메시지는 코드 변경의 이유를 명확히 하고, 팀원 간의 협업을 원활하게 합니다.

이번 블로그에서는 커밋 메시지를 작성할 때 따라야 할 규칙과 팁을 소개하겠습니다.

1. 커밋 메시지의 기본 구조

커밋 메시지는 보통 세 가지 부분으로 나뉩니다:

1. 제목(Title): 커밋의 주요 내용을 간단하게 요약합니다.
2. 본문(Body): 변경 사항에 대한 자세한 설명을 제공합니다.
3. 바닥글(Footer): 이슈 트래커 ID나 참고사항 등 추가 정보를 포함할 수 있습니다.

기본 형식

<제목>

<본문>

<바닥글>

2. 제목 규칙

• 짧고 명확하게: 제목은 50자 이내로 작성하고, 핵심 내용을 간결하게 표현합니다.
• 동사로 시작: 제목은 동사로 시작하여 변경 내용을 설명합니다. 예를 들어, "Add", "Fix", "Update" 등을 사용합니다.
  • 예시: Fix login error on user profile page

3. 본문 규칙

• 어떻게보다 왜에 중점: 본문에서는 변경 사항이 무엇인지보다 왜 이러한 변경을 했는지 설명합니다.
• 행 단위로 작성: 각 문장은 72자 이내로 작성하여 가독성을 높입니다.
• 구체적으로 설명: 문제의 원인, 해결 방법, 그리고 다른 관련 사항을 명확히 설명합니다.
  • 예시

Fixed a bug that caused the login error on the user profile page.

The error was due to an incorrect API endpoint configuration. 
Updated the endpoint and tested the login functionality.

4. 바닥글 규칙

• 이슈 트래커와 연계: 버그나 작업 항목을 참조할 때, 이슈 트래커 ID를 포함합니다.
  • 예시: Closes #123 또는 Refs #456
• 기타 참고사항: 관련 문서나 추가 참고 사항을 포함할 수 있습니다.

5. 커밋 메시지 규칙을 지키는 이유

• 명확한 기록 유지: 커밋 메시지는 코드 변경의 이유와 맥락을 제공하여 나중에 코드 이력을 이해하는 데 도움이 됩니다.
• 팀 협업 용이: 일관된 메시지 규칙은 팀원들이 커밋의 내용을 빠르게 이해할 수 있도록 도와줍니다.
• 버전 관리 시스템 활용: 잘 작성된 메시지는 Git 로그를 활용할 때 유용하며, 코드 리뷰와 디버깅 과정에서 도움이 됩니다.

6. 커밋 메시지 규칙 예시

여기서는 몇 가지 커밋 메시지 규칙을 예시로 보여드리겠습니다:

예시 1: 버그 수정

Fix: Correct API endpoint for user login

Updated the login API endpoint to match the new server configuration.

예시 2: 기능 추가

Add: User profile picture upload functionality

Users can now upload and change their profile pictures from the settings page.

예시 3: 문서 수정

Docs: Update README with new setup instructions

Added details about the new setup process and environment variables.

 

7. 자동화 도구와 템플릿 사용

• Commitlint: 커밋 메시지 규칙을 자동으로 검사하여 일관성을 유지하는 도구입니다.
• Husky: Git hook을 사용하여 커밋 메시지 규칙을 enforce할 수 있는 도구입니다.

이 도구들을 활용하면, 커밋 메시지를 일관되게 작성하는 데 도움이 됩니다.

 

 

Starting Google Play App Distribution! "Tester Share" for Recruiting 20 Testers for a Closed Test.

Tester Share [테스터쉐어] - Google Play 앱