Skip to content

컨벤션

JWL edited this page Dec 15, 2022 · 1 revision

https://www.figma.com/file/sHBKuW87tMkhs98ZiZjUGC/Mandarin-market?node-id=0%3A1&t=1mSjgUxr9ZUon3mm-0

커밋 컨벤션

Type 설명
Add 외부 모듈, 라이브러리 설치
Feat 기능 추가 및 변경
Fix 오류를 고쳤을 때, 버그 수정
Style 코드 스타일 포맷팅(세미콜론, 탭)
Design CSS, UI 디자인
Refactor 코드 리팩토링, 기능 상 변화 없이 가독성과 유지보수성
Comment 주석 추가 및 변경
Test 테스트를 위한 커밋
Docs README 및 github wiki 등 문서 내용 수정,
Merge 수정 없이 GitHub 기본 메시지 사용
Rename 폴더명, 파일명 등의 변경, 디렉터리 이동
Remove 파일을 삭제하는 작업 수행
ETC 위 분류에 넣기 애매한 기타 변경사항(빌드 스크립트 수정 등)

refac 안에 변수, 함수명 변경까지 포함

커밋 메시지 작성법

### 제목
# 커밋 타입: 작업내용

본문 - 한 줄에 최대 72 글자까지만 입력하기

무엇을, 왜, 어떻게 했는지

본문에 여러줄의 메시지를 작성할 땐 "-"로 구분했나요?

컨벤션을 따르려고 하되 변경점 쉽게 알 수 있도록 충분히 자세하게 작성되기만 하면 컨벤션을 엄격하게 지키지 않아도 문제없는 걸로

  1. 제목 (필수)

    Feat: 메인 페이지 아이콘 svg으로 교체
    
  2. 본문 (선택) 무엇을 왜 했는지


close : #


fast-forward merge: 브랜치 한 단계 앞에 가 있으면 merge 불가능 (merge 시 branch가 꼬임)

https://coding-start.tistory.com/333 “-f” 명령어 사용