본문 바로가기

Git

좋은 Git Commit 메시지 작성하기

commit이란? 

개발자가 특정시점의 작업물의 변화 + 메시지를  합하여 시점 전체를 '하나의 스냅샷'으로 저장하는 것입니다.

 

좋은 커밋메시지 작성하기 

영어로 커밋메시지를 작성할 때 좋은메시지 작성을 위해 어느정도 규약이 있습니다.

대신 한글로 작성 할 때는 자유롭게 작성해도 될 것 같습니다. 팀 단위나 회사 있으시면 룰에 따르시거나 정해서 하시면 됩니다.

  1. 제목과 본문 한줄띄워서 분리하기
  2. 제목은 영문 기준 50자 이내
  3. 제목은 명령조로
  4. 제목 첫글자 대문자
  5. 제목 끝에 . 금지
  6. 본문은 72자마다 줄 바꾸기
  7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

커밋메시지 규약도 코드 네이밍과 마찬가지로 여러가지 종류가 있습니다.

제가 사용하기로 정한 한가지를 소개하겠습니다. 😉

 

Semantic Commit Messages

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

  • feat: 새 기능
  • fix: 버그 수정
  • docs: 문서 추가/수장
  • refactor: 코드 리팩토링
  • test: 테스트 추가/수정
feat : 카카오 로그인 기능 추가

kakao의 메신저 알림 사용을 위해 카카오 로그인 연동 기능을 추가했습니다.

이런식으로 사용하시면 됩니다.

Type을 이모티콘으로 할 수도 있습니다.

✨ : Add kakao login feature

kakao의 메신저 알림 사용을 위해 카카오 로그인 연동 기능을 추가했습니다.

이렇게 ㅎㅎ.. 이모지 너무 이쁘네요... 저는 이모지로 하는 방식이 땡기네요. 귀여워.. ☺️

 


 

참고: 공식 이모지 홈페이지 자료

gitmoji.dev/

 

gitmoji

An emoji guide for your commit messages.

gitmoji.dev

참고: 다른분의 이모지 정리 자료

treasurebear.tistory.com/70 

 

Gitmoji 사용하기

Gitmoji란? gitmoji란? Gitmoji = git + emoji 입니다. 글을 쓸 때 이모지를 이용하면, 나중에 글을 읽을때 명확합니다. 👍 커밋할 때도 이모지를 이용한다면, 내용을 한 눈에 알아보기 더 쉽겠죠. 그래서

treasurebear.tistory.com

 

반응형

'Git' 카테고리의 다른 글

이미지 파일 gist에 올리기  (0) 2021.02.03
git 원격저장소 내 로컬저장소와 일치시키기  (0) 2021.01.27
git 변경사항 모두 취소  (0) 2021.01.27
깃허브 프로필 꾸미기  (2) 2021.01.03
Git이란?  (0) 2020.12.09