-
Notifications
You must be signed in to change notification settings - Fork 0
커밋 메시지 컨벤션
ISO edited this page Aug 10, 2023
·
1 revision
타입은 태그와 제목으로 구성된다.
- 태그는 영어로 작성하고 첫 글자는 소문자로
- 제목은 한글로 작성하고
- 태그 뒤에
feat:공백 없이 작성 !
예시)
feat: feat: SaveStateHandler를 활용한 상태저장 및 SharedPreference를 활용한 데이터 저장 구현
feat: docs: Update README.md
feat: 회원가입시 중복 회원가입 확인 로직 추가
refactor: 언론사 리스트 구독 옵저버 패턴 수정
| feat | 새로운 기능 추가 | 기능 |
|---|---|---|
| fix | 버그 수정 | 기능 |
| design | CSS/UI 변경 | 기능 |
| style | 코드 포맷팅 (코드에 논리적 변경사항이 없는 경우) | 개선 |
| refactor | 코드 리팩토링. 새로운 기능이나 버그 수정 없이 현재 구현을 개선 | 개선 |
| comment | 필요한 주석 추가 및 변경 | 개선 |
| establish | 초기 환경설정 / 설정 파일 추가 | 기타 |
| docs | 문서 수정 | 기타 |
| test | 테스트 코드 추가 | 기타 |
| chore | 빌드 업무, 패키지 매니저 수정, 기능 개발과 직접적으로 관련되지 않은 변경사항을 기록하기 위한 타입 | 기타 |
| remove / rename | 파일 삭제 / 파일명 변경 | 기타 |
| res | Resource 파일 추가/수정 | 기타 |
| !HOTFIX | 긴급한 버그 수정 (핫픽스) | 기타 |
- 본문은 해당 커밋에 대하여 상세하고 길게 설명할 필요가 있을 때 선택적으로 작성.
- 어떻게 했는지보다, 무엇을 왜 했는지에 대하여 작성
- 가독성을 위해 한 줄당 75자 이내로 제한하지만, 전체 내용은 양에 상관없이 최대한 상세하게 작성.
타입은 태그와 제목으로 구성된다.
- 태그는 영어로 작성하고 첫 글자는 소문자로
- 제목은 한글로 작성하고
- 태그 뒤에
feat:공백 없이 작성 !
예시)
feat: feat: SaveStateHandler를 활용한 상태저장 및 SharedPreference를 활용한 데이터 저장 구현
feat: docs: Update README.md
feat: 회원가입시 중복 회원가입 확인 로직 추가
refactor: 언론사 리스트 구독 옵저버 패턴 수정
| feat | 새로운 기능 추가 | 기능 |
|---|---|---|
| fix | 버그 수정 | 기능 |
| design | CSS/UI 변경 | 기능 |
| style | 코드 포맷팅 (코드에 논리적 변경사항이 없는 경우) | 개선 |
| refactor | 코드 리팩토링. 새로운 기능이나 버그 수정 없이 현재 구현을 개선 | 개선 |
| comment | 필요한 주석 추가 및 변경 | 개선 |
| establish | 초기 환경설정 / 설정 파일 추가 | 기타 |
| docs | 문서 수정 | 기타 |
| test | 테스트 코드 추가 | 기타 |
| chore | 빌드 업무, 패키지 매니저 수정, 기능 개발과 직접적으로 관련되지 않은 변경사항을 기록하기 위한 타입 | 기타 |
| remove / rename | 파일 삭제 / 파일명 변경 | 기타 |
| res | Resource 파일 추가/수정 | 기타 |
| !HOTFIX | 긴급한 버그 수정 (핫픽스) | 기타 |
- 본문은 해당 커밋에 대하여 상세하고 길게 설명할 필요가 있을 때 선택적으로 작성.
- 어떻게 했는지보다, 무엇을 왜 했는지에 대하여 작성
- 가독성을 위해 한 줄당 75자 이내로 제한하지만, 전체 내용은 양에 상관없이 최대한 상세하게 작성.