Commit Convention

23.12.21.(목) 변경사항

• 커밋 메시지(Subject)의 작업내용 작성 언어 변경(영어 -> 한국어)
• 작업 내용은 개조식으로 작성 내용 추가
  • 개조식: 불필요한 조사, 접속사, 접미어, 형용사를 최소화한 글쓰기 방식
  • 사용 예시: Feat #13: 네트워크 매니저 추가

Description

Commit

• 커밋은 가능한 세분화한 뒤 Push하는 것을 지향한다.

구분

• Subject(제목)
• Body(본문)

Commit Rule

Subject

1. 커밋타입 #이슈번호: 작업 내용 형태로 작성한다.
   • 사용 예: Feat #13: 네트워크 매니저 추가
2. 작업 내용을 50자 이내로 간결하게 작성한다.
3. 마침표 및 특수기호를 사용하지 않는다.
4. 작업 내용은 한글로 작성하며, 개조식을 원칙으로 불필요한 조사, 접속사, 접미어, 형용사를 최소화한다.
5. 커밋타입의 첫 글자는 대문자로 작성한다.

Body

1. 줄구분 시, -로 구분하며 한 줄에 72자 이내 작성을 지향한다.
2. 한글로 자세하게 작성하여, 코드 변경 및 추가 이유를 명확히 한다.

Commit Message

커밋 타입	설명	예시
Feat	새로운 기능 추가
Design	UI 디자인 추가 및 변경
Fix	버그 수정
Docs	문서 수정	.gitignore, readMe
Style	코드 포맷 변경. Production Code 수정이 없는 경우	공백, 포매팅
Comment	주석 추가 및 변경	MARK, TODO
Resource	리소스 추가 및 변경. Production Code 수정이 없는 경우	Asset, JSON파일 추가
Refactor	코드 구조를 개선한 경우
Rename	파일 및 폴더명 수정
Remove	파일, 폴더 및 코드 삭제
Chore	프로젝트 기본 설정과 관련된 내용(빌드, 패키지 매니저 등)으로 Production Code 수정이 없는 경우
HOTFIX	급하고 치명적인 버그 수정