어떤 커밋 메세지가 좋은 커밋 메세지인가?
자아성찰을 해보자면 이제까지 형식 없이 내가 하고싶은 말들을 커밋 메세지로 올렸다.
이제부터 좋은 커밋메세지를 남겨보려고 한다..!
그럼 좋은 커밋 메세지란 무엇일까?
좋은 커밋 메세지의 형태
1. 제목과 본문을 빈 행으로 구분한다
2. 제목을 50글자 내로 제한
3. 제목 첫 글자는 대문자로 작성
4. 제목 끝에 마침표 넣지 않기
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
6. 본문의 각 행은 72글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명한다
커밋 메세지의 구조
<type>(<scope>): <subject> -- 헤더
<BLANK LINE> -- 빈 줄
<body> -- 본문
<BLANK LINE> -- 빈 줄
<footer> -- 바닥 글위와 같은 형태여야 하며 이 중 헤더는 필수이다.
type은 아래의 내용 중 하나여야 한다.
feat : 새로운 기능에 대한 커밋
fix : build 빌드 관련 파일 수정에 대한 커밋
build : 빌드 관련 파일 수정에 대한 커밋
chore : 그 외 자잘한 수정에 대한 커밋(rlxk qusrud)
ci : CI 관련 설정 수정에 대한 커밋
docs : 문서 수정에 대한 커밋
style : 코드 스타일 혹은 포맷 등에 관한 커밋
refactor : 코드 리팩토링에 대한 커밋
test : 테스트 코드 수정에 대한 커밋
footer는 참조 정보를 추가하는 부분이다.
"(#15)"는 연동하고싶은 이슈 번호이다. 생성한 이슈와 연결하고 싶을 경우 이렇게 작성한다.
여러 사람과 함께 개발하는 경우에는 커밋메세지를 형식은 조금씩 다르더라도 공유해야하는 내용들은 모두들어가있어야한다.
새로운 기능을 커밋한 것인지 문서 수정을 한 것인지 팀원들이 쉽게 알 수 있도록 커밋 메세지를 적어야한다!
그렇기 때문에 헤더에 대한 규칙은 반드시 수행해야한다.
'web' 카테고리의 다른 글
| [Git] git remote 명령어 (0) | 2023.08.09 |
|---|---|
| [Node.js] __dirname 사용법 (0) | 2023.08.04 |
| undefined와 null의 차이점 (0) | 2023.07.30 |
| [JAVASCRIPT] 변수 선언 예약어 : var, let, const의 차이 (0) | 2023.07.29 |
| [VSCODE] 왜 내 우측 중괄호는 눌리지 않을까 (0) | 2023.07.28 |