Commit Convention - Likelion-lucky7/DECO GitHub Wiki

Type(제목) 작성 규칙

  • 자주 쓰는 것만 뽑아서 정렬 → 최대한 다양하게
    • A11y : 접근성 관련
    • Chore : 로직상의 변화가 아닌 단순 코드 수정 (세미콜론 수정 등)
    • BugFix : 버그 발견 및 수정
    • Docs : 문서 작성 및 수정 (readme.md 수정 등)
    • Deploy: 배포 관련
    • Refactor : 코드의 리팩토링
    • Style : 컴포넌트 스타일 및 테마 변경 등의 수정 사항
    • Feat : 새로운 기능 추가
    • Add: 기능에 대한 추가적인 작업
    • Comment: 주석 추가 및 변경
    • Rename : 파일명 또는 폴더명, 기능의 이름 수정
    • Remove: 파일 삭제만 진행한 경우
    • Setting : Eslint, dependency, config 파일 등의 수정 사항
    • Move : 파일 또는 코드 이동

📒 제목

  1. 최대 50글자 이내로 작성
  2. 영문 표기 시 동사원형을 가장 앞에 명시(첫 글자는 대문자)
  3. 한글 표기 시 “수정”,”추가” 등의 명령어로 시작
  4. 서술하여 길게 늘이지 않고, 중요한 요점이나 단어만 나열하는 방식으로 작성
  5. [제목] 과 같이 대괄호로 감싸주고 끝나는 대괄호 뒤에 한 칸 띄우고 본문 작성

예시1
[Feat] “추가 채팅기능 구현”

예시2
[Docs] “Edit [[README.md](http://readme.md/)](http://README.md) 수정”


Body(본문) 작성 규칙

코드를 무엇을+왜 변경했는지 설명

  1. 한 줄 당 최대 72자 이내로 작성
  2. 줄 수 제한없이 최대한 상세히 작성
  3. 어떻게 변경 했는지 보다 무엇을 변경했는지, 왜 변경했는지 설명

예시1
채팅방 Entity 및 Dto 생성
채팅 Controller 생성
WebSocketConfiguration 작성

예시2
최신화된 API 기반으로 API 명세서 수정


Footer(꼬리말) 작성 규칙

#이슈넘버로 구성 “#이슈넘버” 형태

  1. 여러 개의 이슈 번호를 적을 때는 쉼표로 구분

예시
#23
#1, #2

⚠️ **GitHub.com Fallback** ⚠️