[Git] 커밋 메시지 작성 요령

1. 제목과 본문으로 나누기

커밋 메시지를 작성할 때는 제목과 본문으로 나누는 것이 좋다. 제목은 변경 사항의 간단한 요약을 작성하고, 본문은 자세한 설명과 변경 사항의 이유 등을 작성한다.

Add : 인증 기능 추가
- AuthEx.class : 멤버의 접근에 대한 인증 기능 추가 (계정 생성, 로그인, 컨텐츠 접근 범위)

 

2. 제목은 간결하고 명확하게 작성

제목은 변경 사항의 핵심 요약을 작성한다. 50자 이내로 작성하며, 명령어 형태 ('Add', 'Update', 'Fix', 'Feat' 등)로 작성하는 것이 좋다.

Fix : 연락처 접근 범위 수정

 

3. 본문은 자세하게 작성

본문은 변경 사항의 자세한 설명을 작성한다. 변경된 파일, 함수, 클래스 등을 명시하고, 변경 사항의 이유와 영향도에 대한 설명을 작성하는 것이 바람직하다.

Update : user 프로필 페이지 업데이트
- UserProfile.html : 사용자 프로필 사진과 생일, 이메일 디스플레이 추가

 

4. 관련 이슈 번호 작성

커밋 메시지에 관련된 이슈 번호를 작성하는 것이 좋다. 이는 코드 변경 사항을 추적하고 향후 관리에 도움을 준다.

Add : 사용자 인증 테스트 코드 추가
- UserAuthTest.class : 사용자 인증에 대한 이슈(#406)에 대한 잠재적 버그 확인을 위한 테스트 코드 작성

 

※ 그 외
- 마침표 사용 금지
- 한글을 사용해도 좋으나, 주로 영어로 사용되는 용어는 영어로 작성
- 문장의 첫 글자는 대문자 등