PIut0 / ERICA_Cheda

체험을 찾다. 체다

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

suggest git commit message rule

HyeseonLee opened this issue · comments

git에 commit을 올릴 때 commit message form을 정하는거 어때요??

문서 작업, 코드 작업이 같이 올라가니까 commit message 앞에 Type만 붙여주어도 이게 어떤 작업을 한 커밋인지 쉽게 알 수 있을 것 같아요!

"Front-end", "Back-end", "Docs", "Etc" 로 작업을 세분화해서 올리면 될거같아요
Front-end, Back-end 는 각 작업에 맞는 커밋에
Docs는 문서나 회의록에, Etc는 각종 TIL이나 개인문서 업로드에 적용해서
[Front-end] (커밋내용) 이런식으로 접두어를 달아주는방식으로 하겠습니다.

commit message에 Front-end Back-end를 구분하는게 좋을까요?? commit message의 기능을 생각했을 때, Front-end, Back-end를 구분한 후 "디테일한 작업의 종류"를 한번 더 언급하는게 좋을 것 같은데 복잡해지지 않을까 걱정이 됩니다:<

만일 [Front-end] [Back-end] 접두어를 붙인다면, 이와 같은 커밋메세지가 작성될 것 같습니다!

[Front-end] feat: Edit mainpage slide box css

3개 박스는 너무 단촐해서 4개로 늘렸습니다.

Resolves: #3

저희의 타입라벨(Type)을 맞추면 좋을 것 같아요! 제가 생각해본 타입라벨은 다음과 같습니다. 추가 하면 좋은것들 올려주세요!!

  • docs: 문서를 수정하는 경우(회의록, TIL, READme.md 등)
docs: Add 20191122 TIL
docs: Edit README.md to include New Features install Django

  • feat: 새로운 기능을 추가할 경우
feat: Edit mainpage map css
feat: Add Django model
  • fix: 버그를 고친 경우

  • etc: 개인 dev 작업물을 올릴 때

  • style: 코드 포맷 변경, 세미콜론 누락, 코드 수정 없는 경우

확인했습니다. 위와 같은 방식으로 폼을 맞춰서 커밋하겠습니다.
추가적으로 아이디어가 생길경우 바로 #2 이슈에 작성하겠습니다.