Skip to content

Convention

Kim Hyunjo edited this page Sep 13, 2022 · 1 revision

Commit Convention

Gitmoji 사용

사용 예시

emoticon + commit message

ex) 🐛 Fix some bugs

종류

⚗️: 실험

🐛: 버그 픽스

✨: 피쳐 추가, 내용 추가

➕ : 의존성 추가

➖ : 의존성 제거

📝: 문서 작업

♻️: 리팩토링

💩: 일단 작성한 기능은 하지만 별로인 리팩토링 필요한 코드

🔥: 코드 삭제

🚑: 핫픽스

💄: css 등 UI 스타일 변경

✅: 테스트 추가 및 수정

🎉: 프로젝트 시작~!~!!

사용법

  • 제목은 영어 동사 원형으로 시작

  • 제목은 50자 이내

  • 제목 마지막에 특수문자 사용 불가

  • 본문은 한줄 띄고 한 줄씩 대시(-) 하나 붙이고 작성

  • 본문은 한 줄 당 72자 내로 작성

  • 본문 내용은 양에 구애받지 않고 최대한 상세히 작성

  • 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명

Branch Strategy

종류

  • main: 배포용

  • dev: 개발 총괄용

  • feat/{issue_num(숫자만)}: 1기능 1feat branch

  • hotfix/{issue_num숫자만)}

사용 방법

  • PR은 dev로

  • PR은 서로 review해주고 1명 이상의 approve가 있는 경우 merge

  • 테스트는 최대한으로

  • API 단위나 기능 단위

Clone this wiki locally