협업시 GitHub 커밋 메시지 관리

GitHub Commit message

공통 규칙

1. 최대한 한글로 작성

2. 본문에 변경 사항을 상세히 작성

커밋 메시지 구성

1. 세 영역으로 구성 (각 영역은 빈 줄로 분리)

• 제목 줄
• 본문 (제목 만으로 표현이 가능할 때에는 생략 가능)
• 꼬리말 (관련 이슈가 없으면 생략 가능)

<유형>: <제목>

<본문>

<꼬리말>  

제목 작성

1. 50자 내로 작성

2. "유형: 제목" 의 형식

3. 커밋 메시지 유형은 다음 중 하나를 사용한다.

• 기능(feat): 기능 추가, 삭제, 변경 (제품 코드 수정 발생)
• 버그(fix): 버그 수정 (제품 코드 수정 발생)
• 리팩토링(refactor): 코드 리팩토링 (제품 코드 수정 발생)
• 형식(style): 코드 형식, 정렬 등의 변경 (제품 코드 수정 발생. 하지만 동작에 영향을 주는 변경은 없음)
• 테스트(test): 테스트 코드 추가, 삭제, 변경 등 (제품 코드 수정 없음. 테스트 코드에 관련된 모든 변경에 해당)
• 문서(docs): 문서 추가, 삭제, 변경 (코드 수정 없음)
• 기타: 위에 해당되지 않는 모든 변경(예: 빌드 스크립트 수정, 패키지 배포 설정 변경 등)을 포함 (코드 수정 없음)
  • 위 유형들이 복합적으로 포함되어 있는 경우, 되도록 커밋을 분리한다. 분리가 어려운 경우에는 위 순서 상 상위 항목의 유형으로 작성한다. (예: 기능과 테스트가 모두 포함된 경우 기능으로 작성)

4. 개조식 구문으로 작성

• 예) "기능: 로그 출력 기능 추가"

본문

1. 한 줄 당 72자 내로 작성 (직접 줄바꿈 필요)

2. 최대한 상세히 작성

3. 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명

꼬리말

1. 이슈 트래커를 작성

2. "유형: #이슈번호" 형식

3. 이슈 트래커 유형은 다음 중 하나를 사용한다.

• 해결: 이슈 해결 시 사용
• 관련: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
• 참고: 참고할 이슈가 있을 때 사용

참조 사이트

• Udacity Git Commit Message Style Guide
• How to Write a Git Commit Message
• https://tttsss77.tistory.com/58
• https://doublesprogramming.tistory.com/256