🧩 Commit convention

참고: Udacity Git Commit Message Style Guide

협업을 진행할 때 누적되는 커밋을 상호간의 코드 리뷰와 이전 로그 탐색을 위해 커밋 메세지에 통일성을 부여해 가독성을 높이자!!!

1. 메세지 구조

메세지는 제목, 본문, 꼬리말로 나누고 각각 공백을 두어 구분하자!!!

<type>: <subject>  // => 제목

<body>             // => 본문

<footer>           // => 꼬리말

type : 어떤 의도로 커밋했는지 명시한다.
subject : 최대 50글자를 넘어가지 않게 하고 마침표는 생략한다. 영문 표기시 동사를 가장 앞에 두고 첫 글자는 대문자로 표기한다.
body : 긴 설명이 필요할 때 작성한다. 어떻게 했는지가 아닌, 무엇을 왜 했는지 작성한다.
footer : issue tracker ID를 명시하고 싶은 경우 작성한다. (권장)

2. `type`

타입은 태그와 제목으로 구성되며, 태그는 영어로 쓰고 첫 글자는 대문자로 작성한다. 태그: 제목 의 형태이며 제목 앞에만 띄어쓰기가 있다.

태그 이름	설명
Feat	새로운 기능을 추가할 경우
Fix	버그를 고친 경우
Design	CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor	프로덕션 코드 리팩토링
Comment	필요한 주석 추가 및 변경
Docs	문서를 수정한 경우
Test	테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore	빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove	파일을 삭제하는 작업만 수행한 경우
Init	프로젝트 초기 생성

3. 태그 작성 방법

3.1. 기능

Feat, Fix, Design, !BREAKING CHANGE 태그가 기능 태그의 종류다.

Feat: 새로운 기능을 추가할 경우
Fix: 버그를 고친 경우
Design: CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE: 커다란 API 변경의 경우 (ex API의 arguments, return 값의 변경, DB 테이블 변경, 급하게 치명적인 버그를 고쳐야 하는 경우)

추가적인 문맥 정보를 제공하기 위한 목적으로 괄호 안에 적을 수도 있다.
```
"Feat(navigation): "
"Fix(database): "
```

3.2. 개선

Style, Refactor, Comment 태그가 개선 태그의 종류다.

Style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor: 프로덕션 코드 리팩토링, 새로운 기능이나 버그 수정없이 현재 구현을 개선한 경우
Comment: 필요한 주석 추가 및 변경

Style의 경우 오타 수정, 탭 사이즈 변경, 변수명 변경 등에 해당하고, Refactor의 경우 코드를 리팩토링 하는 경우에 적용할 수 있다.

3.3. 그 외

Docs, Test, Chore, Rename, Remove 태그가 그 외 태그의 종류다.

Docs: 문서를 수정한 경우
Test: 테스트 추가, 테스트 리팩토링 (프로덕션 코드 변경 없음)
Chore: 빌드 태스크 업데이트, 패키지 매니저 설정할 경우 (프로덕션 코드 변경 없음)
Rename: 파일 혹은 폴더명을 수정하는 경우
Remove: 사용하지 않는 파일 혹은 폴더를 삭제하는 경우

Docs의 경우 README.md 수정 등에 해당하고, Test는 test 폴더 내부의 변경이 일어난 경우에만 해당한다.

Chore의 경우 package.json의 변경이나 dotenv의 요소 변경 등, 모듈의 변경에 해당된다.

4. 제목 작성법

제목은 코드 변경 사항에 대한 짧은 요약을 나타낸다.

제목은 아래의 규칙을 지키자!!!

제목의 처음은 동사 원형으로 시작한다.
총 글자 수는 50자 이내로 작성한다.
마지막에 특수문자는 삽입하지 않는다.
- 마침표(.), 느낌표(!), 물음표(?)
제목은 개조식 구문으로 작성한다.
- 세렝게티에는 다수의 멋쟁이 사자가 서식하고 있습니다. // => 세렝게티: 다수의 멋쟁이 사자 서식
첫 글자는 대문자로 작성한다.
"Fix", "Add", "Change"의 명령어로 시작한다.

5. 본문 작성 방법

본문은 아래의 규칙을 지키자!!!

본문은 한 줄 당 72자 내로 작성한다.
본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.

6. 꼬리말 작성 방법

꼬리말은 아래의 규칙을 지키자!!!

꼬리말은 optional이고 이슈 트래커 ID를 작성한다.
꼬리말은 "유형: #이슈 번호" 형식으로 사용한다.
여러 개의 이슈 번호를 적을 때는 쉼표로 구분한다.
이슈 트래커 유형은 다음 중 하나를 사용한다.
- Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
- Resolves: 이슈를 해결했을 때 사용
- Ref: 참고할 이슈가 있을 때 사용
- Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
  - Fixes: #45 Related to: #34, #23

7. 작성 예시

Design: Update dashboard UI

Enhanced dashboard interface with better visuals and responsive design

Resolves: #420
Ref: #321
Related to: #215, #270

Feat: Add login function

Implemented login function using OAuth2

Resolves: #232
Related to: #129, #74

8. gitmoji

터미널에서 소스를 커밋할때 gitmoji-cli를 이용하면 이모지를 함께 커밋내용에 간단하게 포함시킬수 있다.

8.1. Install

> npm i gitmoji-cli

8.2. Usage

먼저 git add 명령어로 변경 사항을 스테이징 하고, git commit -m 대신에 gitmoji -c 로 커밋메시지를 작성하면 된다.
커맨드를 실행하면 emoji 리스트들이 나와 화살표를 이용해 위아래로 이동하며 선택을 하거나 원하는 keyword를 작성하여 emoji를 고를 수도 있다.

❯ npx gitmoji -c
✔ Gitmojis fetched successfully, these are the new emojis:
? Choose a gitmoji: (Use arrow keys or type to search)
❯ 🎨  - Improve structure / format of the code. 
  ⚡️  - Improve performance. 
  🔥  - Remove code or files. 
  🐛  - Fix a bug. 
  🚑️  - Critical hotfix. 
  ✨  - Introduce new features. 
  📝  - Add or update documentation. 
(Move up and down to reveal more choices)

emoji를 선택한 후에는 commit title과 commit message를 작성하고 엔터를 치면 commit을 완료하면 된다.

? Choose a gitmoji: 📦️  - Add or update compiled files or packages.
? Enter the commit title [21/48]: Feat: Add gitmoji-cli
? Enter the commit message: Add CLI for using emojis in git commit messages

9. Gitmoji - Visual Studio Marketplace

확장프로그램에서 설치

스크린샷 2023-07-28 00 40 41

아이콘으로 Gitmoji 선택

스크린샷 2023-07-28 00 42 56

알맞는 Gitmoji 선택 후

스크린샷 2023-07-28 00 43 02

commit 진행

스크린샷 2023-07-28 00 43 28

10. gitmoji 설명

아이콘	설명
🎨	코드의 형식 / 구조를 개선 할 때
--	--
📰	새 파일을 만들 때
📝	사소한 코드 또는 언어를 변경할 때
🐎	성능을 향상시킬 때
📚	문서를 쓸 때
🐛	버그 reporting할 때, @FIXME 주석 태그 삽입
🚑	버그를 고칠 때
🐧	리눅스에서 무언가를 고칠 때
🍎	Mac OS에서 무언가를 고칠 때
🏁	Windows에서 무언가를 고칠 때
🔥	코드 또는 파일 제거할 때 , @CHANGED주석 태그와 함께
🚜	파일 구조를 변경할 때 . 🎨과 함께 사용
🔨	코드를 리팩토링 할 때
☔️	테스트를 추가 할 때
🔬	코드 범위를 추가 할 때
💚	CI 빌드를 고칠 때
🔒	보안을 다룰 때
⬆️	종속성을 업그레이드 할 때
⬇️	종속성을 다운 그레이드 할 때
⏩	이전 버전 / 지점에서 기능을 전달할 때
⏪	최신 버전 / 지점에서 기능을 백 포트 할 때
👕	linter / strict / deprecation 경고를 제거 할 때
💄	UI / style 개선시
♿️	접근성을 향상시킬 때
🚧	WIP (진행중인 작업)에 커밋, @REVIEW주석 태그와 함께 사용
💎	New Release
🔖	버전 태그
🎉	Initial Commit
🔈	로깅을 추가 할 때
🔇	로깅을 줄일 때
✨	새로운 기능을 소개 할 때
⚡️	도입 할 때 이전 버전과 호환되지 않는 특징, @CHANGED주석 태그 사용
💡	새로운 아이디어, @IDEA주석 태그
🚀	배포 / 개발 작업 과 관련된 모든 것
🐘	PostgreSQL 데이터베이스 별 (마이그레이션, 스크립트, 확장 등)
🐬	MySQL 데이터베이스 특정 (마이그레이션, 스크립트, 확장 등)
🍃	MongoDB 데이터베이스 특정 (마이그레이션, 스크립트, 확장 등)
🏦	일반 데이터베이스 별 (마이그레이션, 스크립트, 확장명 등)
🐳	도커 구성
🤝	파일을 병합 할 때

11. Commit template 등록하기

.gitmessage.txt 파일 생성

모든 프로젝트에 global로 적용하는 경우 ~/(사용자의 HOME 디렉토리)에 생성한다. touch ~/.gitmessage.txt
현재 프로젝트에만 적용하는 경우 프로젝트의 루트 경로에 생성한다. touch .gitmessage.txt

템플릿 작성 생성한 .gitmessate.txt 파일에 템플릿을 작성한다.

# 제목은 최대 50글자까지 아래에 작성: ex) Feat: Add Key mapping  

# 본문은 아래에 작성  

# 꼬릿말은 아래에 작성: ex) Github issue #23  

# --- COMMIT END ---  
#   <타입> 리스트  
#   feat        : 기능 (새로운 기능)  
#   fix         : 버그 (버그 수정)  
#   refactor    : 리팩토링  
#   design      : CSS 등 사용자 UI 디자인 변경  
#   comment     : 필요한 주석 추가 및 변경  
#   style       : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)  
#   docs        : 문서 수정 (문서 추가, 수정, 삭제, README)  
#   test        : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)  
#   chore       : 기타 변경사항 (빌드 스크립트 수정, assets, 패키지 매니저 등)  
#   init        : 초기 생성  
#   rename      : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 한 경우  
#   remove      : 파일을 삭제하는 작업만 수행한 경우  
# ------------------  
#   제목 첫 글자를 대문자로  
#   제목은 명령문으로  
#   제목 끝에 마침표(.) 금지  
#   제목과 본문을 한 줄 띄워 분리하기  
#   본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.  
#   본문에 여러줄의 메시지를 작성할 땐 "-"로 구분  
# ------------------  
#   <꼬리말>  
#   필수가 아닌 optioanl  
#   Fixes        :이슈 수정중 (아직 해결되지 않은 경우)  
#   Resolves     : 이슈 해결했을 때 사용  
#   Ref          : 참고할 이슈가 있을 때 사용  
#   Related to   : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)  
#   ex) Fixes: #47 Related to: #32, #21

스크린샷 2023-07-28 01 14 37

git config로 template 설정

global로 적용하는 경우 git config --global commit.template ~/.gitmessage.txt
현재 프로젝트에만 적용하는 경우 git config commit.template .gitmessage.txt

커밋 메시지 작성 git commit 으로 vi 편집기를 열어서 작성한다.
template 설정 해제

global로 적용한 경우 git config --unset --global commit.template
현재 프로젝트에만 적용한 경우 git config --unset commit.template

Navigation Menu

Uh oh!

🧩 Commit convention

1. 메세지 구조

2. `type`

3. 태그 작성 방법

3.1. 기능

3.2. 개선

3.3. 그 외

4. 제목 작성법

5. 본문 작성 방법

6. 꼬리말 작성 방법

7. 작성 예시

8. gitmoji

8.1. Install

8.2. Usage

9. Gitmoji - Visual Studio Marketplace

10. gitmoji 설명

11. Commit template 등록하기

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally

Uh oh!

🧩 Commit convention

1. 메세지 구조

2. type

3. 태그 작성 방법

3.1. 기능

3.2. 개선

3.3. 그 외

4. 제목 작성법

5. 본문 작성 방법

6. 꼬리말 작성 방법

7. 작성 예시

8. gitmoji

8.1. Install

8.2. Usage

9. Gitmoji - Visual Studio Marketplace

10. gitmoji 설명

11. Commit template 등록하기

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally

2. `type`