협업을 위한 컨벤션, Gitmoji

 

VSCode

VSCode에서 Gitmoji extension을 설치해주면, 다음과 같이 쉽게 관련 이모지를 찾을 수 있다!!

 

 

CLI

CLI에서는 아래와 같이 입력해서 사용 가능하다 !

# gitmoji 설치
brew install gitmoji # mac
npm i -g gitmoji-cli # window (node.js 먼저 설치)

gitmoji -c # git commit -m [메세지] 대신

 

Gitmoji 한눈에 보기

emoji	code	description
🎨	:art:	코드의 구조/포맷 개선
⚡️	:zap:	성능 개선
🔥	:fire:	코드/파일 제거
🐛	:bug:	버그 수정
🚑️	:ambulance:	긴급 수정
✨	:sparkles:	새로운 기능
📝	:memo:	문서 추가/업데이트
💄	:lipstick:	UI, style files 추가/업데이트
🎉	:tada:	프로젝트 시작
✅	:white_check_mark:	테스트 추가/수정/패스
🔒️	:lock:	보안 이슈 수정
🔐	:closed_lock_with_key:	암호 추가/수정
🔖	:bookmark:	릴리즈/버전 태그
🚨	:rotating_light:	compiler/linter 경고 수정
🚧	:construction:	진행 중
💚	:green_heart:	CI 빌드 수정
⬇️	:arrow_down:	dependencies 다운그레이드
⬆️	:arrow_up:	dependencies 업그레이드
📌	:pushpin:	특정 버정 dependencies 고정
👷	:construction_worker:	CI 빌드 시스템 추가/수정
📈	:chart_with_upwards_trend:	분석, 추적 코드 추가/수정
♻️	:recycle:	리팩토링
➕	:heavy_plus_sign:	dependency 추가
➖	:heavy_minus_sign:	dependency 제거
🔧	:wrench:	configuration files 추가/수정
🔨	:hammer:	development scripts 추가/수정
🌐	:globe_with_meridians:	국제화 및 현지화
✏️	:pencil2:	오타 수정
💩	:poop:	개선이 필요한 bad code
⏪️	:rewind:	변경 내용 되돌림
🔀	:twisted_rightwards_arrows:	브랜치 merge
📦️	:package:	컴파일된 파일/패키지 추가/수정
👽️	:alien:	외부 API 변화로 인한 코드 수정
🚚	:truck:	리소스(e.g.: files, paths, routes) 이동/리네임
📄	:page_facing_up:	라이센스 추가/수정
♿️	:wheelchair:	접근성 개선
💡	:bulb:	주석 추가/수정
💬	:speech_ballon:	텍스트/리터럴 추가/수정
🗃️	:card_file_box:	데이터베이스 관련
🔊	:loud_sound:	로그 추가/수정
🔇	:mute:	로그 제거
👥	:busts_in_silhouette:	contributor(s) 추가/수정
🤡	:clown_face:	Mock things
🙈	:see_no_evil:	.gitignore 추가/수정
💫	:dizzy:	animations/transitions 추가/수정
🩹	:adhesive_bandage:	간단한 문제 해결
⚰️	:coffin:	dead code 제거

 

유다시티 스타일

• 크게 제목, 본문, 꼬리말 세가지 파트로 나뉨
• 현재 가장 대중적인 컨벤션

유다시티 스타일 커밋 메세지 컨벤션 구조
type : subject (제목)
body : (본문)
footer : (꼬리말)

 

타입 (Type)

• 어떤의도로 커밋했는지 타입에 명시
• 다음 7개의 타입 중 하나로 사용할 것을 권장

타입 이름	설명
✨ feat	새로운 기능 추가
🐛 fix	버그 수정
📝 docs	문서 수정
🎨 style	들여쓰기, 세미 콜론등을 변경하였을때
♻️ refactor	코드 리팩토링을 했을 때
✅ test	test 코드의 작성 및 수정이 이루어졌을 때
🔧 chore	외부 라이브러리 임포트 등의 작업을 완료했을 때

 

제목 (Subject)

• 타입 : 제목 형식으로 사용
• 대문자로 시작하는 명령형 문장이며 50자를 넘지 않도록 작성
• 개조식 구문으로 작성

 

본문 (Body)

• 한 줄 당 72자 내로 작성
• 제목과 달리 양에 구애받지 않고 최대한 상세히 작성
• 무엇을 왜 변경했는지 설명

 

꼬리말 (footer)

• 선택 사항이며, 이슈 트래커 ID 를 작성
•  유형 : # 이슈 번호 형식으로 사용
• 여러 개의 이슈 번호를 적을 때는 쉼표(,) 로 구분

이슈 트래커 유형	설명
Fixes	issue 수정중 (아직 해결 안됨)
Resolves	issue 해결 완료
Ref	참고할 issue 존재 시
Related to	해당 커밋에 관련된 이슈 번호 (아직 해결 안됨)

 

예시

Feat [type] : 추가 조회 메소드 추가 [subject] 

 

회원가입 API 개발 [body] 

 

Resolves: #123 [footer] 

Ref: #456 

Related to : #100