지금까지 정말 아무렇게나 커밋을 해왔었는데 이제부터라도 정말 좋은 커밋 습관을 들여야겠다.
<좋은 커밋 메세지의 7가지 규칙>
- 제목과 본문을 한 줄 띄워 분리하기
- 제목은 영문 기준 50자 이내로
- 제목 첫 글자를 대문자로
- 제목 끝에 . 금지
- 제목은 명령조로
- Github - 제목(이나 본문)에 이슈 번호 붙이기
- 본문은 영문 기준 72자마다 줄 바꾸기
- 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기
<커밋 메시지 구조>
$ <type>(<scope>): <subject> -- 헤더
<BLANK LINE> -- 빈 줄
<body> -- 본문
<BLANK LINE> -- 빈 줄
<footer> -- 바닥 글<type>은 해당 commit의 성격을 나타내며 아래 중 하나여야 합니다.
feat : 새로운 기능에 대한 커밋
fix : build 빌드 관련 파일 수정에 대한 커밋
build : 빌드 관련 파일 수정에 대한 커밋
chore : 그 외 자잘한 수정에 대한 커밋(rlxk qusrud)
ci : CI 관련 설정 수정에 대한 커밋
docs : 문서 수정에 대한 커밋
style : 코드 스타일 혹은 포맷 등에 관한 커밋
refactor : 코드 리팩토링에 대한 커밋
test : 테스트 코드 수정에 대한 커밋<body>는 본문으로 헤더에서 생략한 상세한 내용을 작성합니다. 헤더로 충분한 표현이 가능하다면 생략이 가능합니다.
<footer>는 바닥글로 어떤 이슈에서 왔는지와 같은 참조 정보를 추가하는 용도로 사용합니다.
Ref
출처: https://xtring-dev.tistory.com/entry/Git-규칙적인-Commit-메세지로-개발팀-협업하기-👾 [xtring.dev:티스토리]
'[IT 지식] > 개발 도구 & 개발 환경' 카테고리의 다른 글
| 인텔리제이로 스프링부트 프로젝트 생성하기 (0) | 2023.03.20 |
|---|---|
| [Git] README.md(Markdown) 작성법 (0) | 2022.09.06 |
| [Eclipse] 과정평가형 정보처리산업기사 - 이클립스 기본 세팅 (0) | 2022.08.17 |
| [Eclipse] JUnit이란? JUnit 사용방법 & 단위 테스트 방법 (0) | 2022.08.16 |
