티스토리 뷰

Tip and Error/Github

commit 메시지

geonwoopaeng@gmail.com 2021. 8. 18. 17:34
  • github를 하면서 commit 메시지를 계속 나에 맞춰서 바꿔왔는데 이렇게 있었다니 ;;;;
  • 이제라도 이렇게 작성을 하면서 나의 실력을 늘려가야 겠습니다.

 

출처: https://github.com/naver/billboard.js

> Structure(구조)

type(<scope>): <subject>     - 헤더
<br>                         - 빈칸
[body]                         - 본문
<br>                         - 빈칸
[footer]                     - 바닥글

 

1. 커밋 성격(type)

<많이 사용>

- feat: 새로운 기능 추가

- chore: 빌드 업무 수정, 패키지 매니저 수정(자잘한 수정)

- docs: 문서 수정

- fix: 버그 수정

- refactor: 코드 리펙토링

 

<조금 사용>

- test: 테스트 코드, 리펙토링 테스트 코드 추가

- build: 빌드 관련 파일 수정

- style: 코드 스타일, 세미콜론 누락, 코드 변경(X)

- ci: CI관련 설정 수정

 

2. Subject

- 영문 기준 50자 넘기지 않는다

- 첫 글자 대문자로 작성

- 마침표 붙이지 않는다

- 과거시제 사용 X

- 명령어로 작성

 

3. 본문(body)

- 커밋에 관한 설명 작성

- 영문기준 72자마다 줄 바꾸기

- 어떻게 보다 무엇을, 에 초점 맞추기

 

4. 꼬리말(footer)

- issue tracker id를 작성할 때 사용(참조 정보)

 

REF

https://meetup.toast.com/posts/106

https://github.com/naver/billboard.js

https://github.com/angular/angular/commits/master

 

반응형
공지사항
최근에 올라온 글