깃 컨벤션

깃 커밋 컨벤션은 개발자들이 프로젝트의 변경 사항을 일관되고 명확하게 기록하기 위한 규칙
이를 통해 협업과 코드 리뷰가 더욱 효율적으로 이루어질 수 있다.

커밋 메시지 구조

커밋 메시지는 크게 세 부분으로 구성:

1. 제목 (Subject)
2. 본문 (Body)
3. 꼬리말 (Footer)

각 부분은 빈 줄로 구분되며, 전체 메시지는 가독성을 위해 한 줄에 100자를 넘지 않도록 작성한다[1][2].

제목 (Subject) 작성 규칙

• 최대 50글자를 넘지 않도록 한다[1].
• 첫 글자는 대문자로 시작한다[1].
• 마침표나 특수 기호는 사용하지 않는다[1].
• 명령문으로 작성하며, 간결하고 요점적인 서술을 사용한다[1].

커밋 타입

커밋 제목은 타입으로 시작하며, 주요 타입:

• Feat: 새로운 기능 추가
• Fix: 버그 수정
• Refactor: 코드 리팩토링
• Design: UI 디자인 변경
• Style: 코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우
• Test: 테스트 코드 추가, 수정, 삭제
• Chore: 빌드 작업, 패키지 매니저 설정 등
• Docs: 문서 수정

본문 (Body) 작성 규칙

• 한 줄당 72자 내로 작성한다[1].
• 변경 사항에 대해 상세히 설명한다.
• "어떻게" 보다는 "무엇을", "왜" 변경했는지에 초점을 맞춘다[1].

꼬리말 (Footer) 작성 규칙

• 이슈 트래커 ID를 참조할 때 사용한다.
• "유형: #이슈 번호" 형식으로 작성한다[1].
• 주요 이슈 트래커 유형:
  • Fixes: 이슈 수정 중
  • Resolves: 이슈 해결
  • Ref: 참조할 이슈
  • Related to: 해당 커밋과 관련된 이슈

커밋 템플릿 활용

효율적인 커밋 메시지 작성을 위해 커밋 템플릿을 사용할 수 있다. 템플릿을 설정하면 git commit 명령어 실행 시 자동으로 템플릿이 로드되어 일관된 형식의 커밋 메시지를 쉽게 작성할 수 있다[1].

깃 커밋 컨벤션을 따르면 프로젝트의 히스토리를 더 쉽게 이해하고 관리할 수 있으며, 팀 협업 시 의사소통을 원활하게 할 수 있다.

Citations:
[1] https://kdjun97.github.io/git-github/commit-convention/
[2] https://3uomlkh.tistory.com/116
[3] https://devalice.tistory.com/102
[4] https://haesoo9410.tistory.com/300
[5] https://doublesprogramming.tistory.com/256
[6] https://duektmf34.tistory.com/206
[7] https://overcome-the-limits.tistory.com/entry/%ED%98%91%EC%97%85-%ED%98%91%EC%97%85%EC%9D%84-%EC%9C%84%ED%95%9C-%EA%B8%B0%EB%B3%B8%EC%A0%81%EC%9D%B8-git-%EC%BB%A4%EB%B0%8B%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0
[8] https://velog.io/@shin6403/Git-git-%EC%BB%A4%EB%B0%8B-%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0