dy6578ekdbs/EFUB_Toy_Project_Twitter

Udacity Git Commit Message Style Guide

Closed this issue · 0 comments

1. 형식

<type>: <description>

[optional body]

<type>: <description> 부분이 커밋의 제목이 되며, 이 부분은 영어로 작성한다.


2. type

! 소문자로 적을 것

feat: 새로운 기능 추가
fix: 버그 수정
docs : 문서 추가, 변경
style: 코드 포맷팅 (띄어쓰기나 탭 등의 수정. 코드 수정은 없어야 함.)
refactor: 코드 리팩토링
test: 테스트 코드 추가, 수정
chore: 빌드 업무 수정, 패키지 매니저 수정

3. description

무엇을 했는지 또는 왜 했는지 설명을 적는 부분이다.
현재 시제나 명령어로 적고 영어를 사용한다.
적당한 줄임말은 허용하나 알아볼 수 있게 쓴다.
주로 add, update, fix를 쓴다.


3. Body

선택사항으로, description보다 더 자세하게 작성한다.
한글, 영어 자유롭게 작성한다.


4. 예시

feat: Summarize changes in around 50 characters or less

설명설명설명설명
- 이렇게 bulleted list도 가능함
1. 이렇게 numbered list도 가능함

레퍼런스

https://udacity.github.io/git-styleguide/