Repository navigation
01. Commit Message Style Guide
kwak-bs edited this page Aug 23, 2021
·
4 revisions
ONE-TED팀이 지향하는 Git commit message 스타일 가이드입니다.
| 타입 | 설명 |
|---|---|
| Feat : | 기능 추가, 삭제, 변경 |
| Fix : | 버그 해결, 잘못된 코드 변경 |
| Refactor : | 코드 리팩토링 ex) 변수명 변경 |
| Style : | UI 스타일링 |
| Docs : | 문서 추가, 삭제, 변경 ex) README.md |
| Chore : | 나머지 모든 변경 ex) 빌드 스크립트, 패키지, 폴더, 파일명 변경, 이미지 추가 등등 |
| Init : | 초기 생성 및 개발환경 설치 |
| Test : | 테스트 코드 추가, 삭제, 변경 |
- 커밋 메세지 한글 / 영문 선택은 각 기업 과제를 진행할 팀과 자율적으로 선택
- 제목과 본문을 한 줄 띄워 분리하기
- 본문은 "어떻게" 보다 "무엇을", "왜" 위주로 작성한다.
- 아래와 같이 작성한다.
git commit -m "[#issue_number] Feat : Add infinite scroll-
git commit=> (vi 열림)
// vi
[#3] Feat: Add infinite scroll list
(한 줄 띄우고)
The infinite scroll function is bla bla bla~~.
⇒ 이렇게 작성하시면 PR 할 때 알아서 제목과 본문으로 나뉘어 작성이 됩니다.