커밋 메시지 형식

[SeonHyungJo]

커밋 메시지를 좀 더 알아보기 좋은 형태로 변경하자.

위와 같이 나온 배경은 아래의 링크를 들어가면 알 수 있습니다. ⬇️ https://github.com/im-d-team/Dev-Docs/pull/138#issuecomment-643777503

---

해당 이슈에서 확정된 내용은 https://github.com/im-d-team/Dev-Docs/blob/master/Rules/Commit.md 에 업데이트됩니다.

[SeonHyungJo]

[BKJang]

Commit Type

커밋의 사용되는 타입은 크게 4가지로 구분한다.

• create: Create docs(새로운 문서 생성)
• update/{reviewerName}: Update docs(PR상 올라가 있는 문서 수정)
• hotfix: Update docs without brach(Master 머지 후 발견된 수정 사항)
• maintain: Update README.md(기타 문서 수정)

Example

// 괄호도 포함하는 메시지

[create]: Create Scope.md

[update/BKJang]: 서브넷 네트워크와 네트워크 주소 차이 추가(최대한 자세하게)
[update/sNyung]: 네트워크 주소 예시 수정(최대한 자세하게)

[hotfix]: 띄어쓰기
[hotfix]: 오탈자 수정

[maintain]: Update README.md (Add commit message type)

github.com에서 새로운 파일 올리기

Create new file => Click

자신의 글 작성 및 하단으로 이동

커밋메시지 타입 중 create를 사용하여 작성

github.com에서 파일 수정하기

자신의 PR로 들어감

Files changed => 우측 vertical dots 클릭 => edit file 클릭

글 수정 및 하단 메시지 이동

update 타입을 사용하여 작성 및 commit 클릭

[Dae-Hwa]

커밋메세지의 상세 부분에 어떤 리뷰인지 링크 달아주는 것도 괜찮을 것 같습니다.

[jigi-kim]

Commit Type

커밋의 사용되는 타입은 크게 4가지로 구분한다.

• create: Create docs(새로운 문서 생성)
• update/{reviewerName}: Update docs(PR상 올라가 있는 문서 수정)
• hotfix: Update docs without brach(Master 머지 후 발견된 수정 사항)
• maintain: Update README.md(기타 문서 수정)

Example

// 괄호도 포함하는 메시지

[create]: Create Scope.md

[update/BKJang]: 서브넷 네트워크와 네트워크 주소 차이 추가(최대한 자세하게)
[update/sNyung]: 네트워크 주소 예시 수정(최대한 자세하게)

[hotfix]: 띄어쓰기
[hotfix]: 오탈자 수정

[maintain]: Update README.md (Add commit message type)

새로 정해진 commit message 양식이 이전 양식의 부족한 점을 잘 채워주고 있는 것 같아 좋네요!

관련 논의가 이루어진 날 함께 참여하지 못해 미안할 따름입니다... 😅

정해진 양식에 대해 개인적인 의견을 남깁니다.

1. 괄호를 포함하여 [commit type]: subject 형식으로 되어 있는데, type과 subject를 구분하기 위한 구분자로 [] 와 : 중 하나만 있어도 괜찮지 않을까 싶네요.
2. update 및 hotfix type에 대해서는 어떠한 파일에 대한 변경사항인지가 표시되지 않아도 괜찮을까요?
3. 파일명과 같이 특수한 경우가 아니라면, 언어 표기(국문/영문)는 하나로 정하는 것이 보기 좋을 것 같습니다.

[Dae-Hwa]

이런건 어떨까요?

1. 각 제목을 커밋 내용으로

#제목
##대분류
###중분류

[update/Dae-Hwa] : 대분류-중분류/항목 순서 변경

2. 리뷰 작성 시 제목부여 e.g. 본인이름-순번

[update/Dae-Hwa-1] : 항목 순서 변경