Git 커밋 메시지 작성 팁

커밋 코멘트가 중요한 이유

 

Git commit 코멘트를 작성하는 것은 프로젝트의 이력을 관리하고 협업을 원활하게 하는데 매우 중요하다.

다른 개발자들과 함께 일하거나 나중에 코드를 리뷰하거나 수정해야 할 때 명확하고 유용한 커밋 메시지를 작성하는 것이 좋다.

 

Git commit 코멘트를 작성하는 팁

 

1. 명확하고 간결하게 작성

• 50에서 72자 정도로 간결하게

2. 제목과 내용 분리

• 제목은 간결하게 작성하고, 바로 해당 커밋의 요약을 나타낼 것
• 내용에는 세부 변경 사항과 이유 등을 더 자세히 기록

3. 명령어 사용

• 제목은 커밋의 성격을 나타내기 위해 명령어 형태로 작성하는 것이 일반적
• 예) Add, Fix, Update, Remove 등

4. 제목 첫 글자는 대문자, 끝에는 마침표 사용

• 제목은 문장으로 보이도록 첫 글자를 대문자로 시작, 마지막에 마침표를 사용하는 것이 좋음

5. 올바른 시제 사용 

• 일반적으로 Git 커밋 메시지는 현재 시제를 사용
• 예) Add feature, Fix bug 

6. 관련 이슈 트래킹

• 커밋과 연관된 이슈 번호가 있다면 제목이나 내용에 이슈 트래커를 포함시켜 관련 이슈를 더 쉽게 추적 가능
• 예) Add feature XYZ(#123)

7. 한 번에 한 가지 변경 사항

• 너무 많은 변경 사항이 한 커밋에 포함되면 추적이 어려워질 수 있음

8. 리뷰와 협업

• 다른 사람이 읽었을 때도 이해하기 쉽도록 작성

9. 커밋 메시지 템플릿 사용

• 커밋 메시지의 구조와 형식을 일관성 있게 유지할 수 있음

커밋 메시지 예시

Add new feature XYZ

This commit adds a new feature XYZ to the project. The feature allows users to perform action A and action B by clicking on the button.

Fix issue with user login

This commit fixes a bug that prevented users from logging in when using a specific browser. The issue was caused by an incorrect encoding of user credentials.