Skip to content

Commit Convention

sunnyCookie edited this page May 26, 2023 · 3 revisions

커밋 메세지는 아래와 같이 제목 / 본문으로 구성한다.

type #이슈번호: subject 
	
body
ex1)
💄#27: 메인 화면 구현 

ex2)
🐛#28: ~~ 문제 해결

- ~~~로 인한 ~~~문제 ~~~로 해결

1️⃣ Commit Type - Gitmoji 사용

feat 새로운 기능을 추가
💄 design UI 같은 스타일 내용을 추가하거나 업데이트
🐛 fix 버그 수정
📝  docs 문서(README나 Wiki)를 추가하거나 업데이트
🎨 style 코드구조 혹은 코드형식 개선합니다. (코드의 변화가 생산적인 것이 아닌 경우)
♻️ refactor 코드 리팩토링 (내부 로직은 변경 하지 않고 기존의 코드 개선하는 리팩토링, 줄바꿈 포함)
test 테스트 추가, 업데이트
⚡️ perf 성능 향상
👷 build CI 빌드 시스템을 추가하거나 업데이트
📦️ package 컴파일된 파일 또는 패키지를 추가, 업데이트
🛠  chore 이 외 Code 변경 없는 셋팅관련 (허드렛일..)
🩹 merge Solve Merge중 발생한 문제 해결

2️⃣ Subject

  • 제목은 50자를 넘기지않고, 마침표를 붙이지 않는다.
  • 과거형보다는 현재형을 사용한다.
  • 한글을 사용합니다.

3️⃣ Body

  • 선택사항이다. (모든 커밋에 body를 작성할 필요 없다.)
  • 부연설명이 필요하거나 커밋 이유를 설명할 때 작성한다.
  • 72자를 넘기지 않고 제목과 구분되기 위해 한 칸 띄워 작성한다.
  • 내용은 어떻게 변경했는지 ****보다 무엇을 변경했는지 또는  변경했는지를 설명한다.