Git Commit Message Guideline

📖 멀티라인 커밋 작성 방법

---

1. git commit → 에디터 열림
2. 에디터에서 아래 template에 맞춰 커밋 메세지 작성
3. :wq 로 저장

 

✅ 분류

---

• Add - 레이아웃 / 기능 추가
• Remove - 내용 삭제 (폴더 / 파일 삭제)
• Modify - 수정 (JSON 데이터 포맷 변경 / 버튼 색깔 변경 / 폰트 변경)
• Fix - 버그/오류 해결
• Refactor - 코드 리팩토링 (멘토 리뷰 반영 / 스스로 리팩토링 / 중복 코드 제거 / 불필요 코드 제거 / 성능 개선)
• Docs - 문서에 관련된 수정작업(README.md 등)

 

🧾 Template

---

분류: 한줄 제목
- 구현내용 detail
- 구현내용 detail

 

📌 예시 1 - Add

Front-end

 

Add: 이미지 슬라이더 추가
- 메인페이지 이미지 슬라이더 구현
- 3초 간격으로 자동으로 넘어가는 기능 구현

Back-end

Add: User app 생성 및 회원가입 엔드포인트 추가
- 유저 앱을 만들고, 유저 모델 클래스 생성
- 회원가입 엔드포인트 구현

 

 

📌 예시 2 - Remove

---

Front-end

Remove: 불필요 컴포넌트 삭제
- MyPage 가 더 이상 필요없어짐에 따라 파일 삭제

Back-end

Remove: data csv 파일 삭제
- 크롤링 결과 저장한 csv이 git에 잘못 올라와 해당 파일 삭제

 

 

📌 예시 3 - Fix

---

Front-end

Fix: 스크롤 버그 수정
- 스크롤시 Navbar 사라지는 버그 확인 후 수정

Back-end

Fix: 상품 정보 입력시 필수 정보인 상품 사진 url 예외처리
- 필수 입력 값인 image url이 body에 담겨있지 않을 때 key error 오류 처리
- Return되는 오류 메시지 수정 (500 error -> 400 key error with 'image_url')

 

 

🤔 참고할 점

---

• 제 3자가 알아 볼수 있게 적는다.

로그인 기능이 문제가 있어서 수정함 (x)
로그인 시도시 API 호출이 제대로 일어나지 않아 로그인이 되지 않는 버그 수정 (o)

매장 데이터 검색 만듦(x)
매장 위치 조회시 매장 위치의 위도/경도를 기준으로 필터링하는 기능 구현(o)

 

🎯 실제 예시

---

( 9기 정수영님의 훌륭한 예시 ❤️)

 

 

참고자료

Udacity Nanodegree Style Guide

깃 커밋 메시지 컨벤션 (Git Commit Message Convention)