커밋 규칙 - Wo-oJin/Ari GitHub Wiki

Commit message 7가지 규칙

  1. 제목과 본문을 한 줄 띄어 구분
  2. 제목은 50자 이내
  3. 제목 첫 글자는 대문자
  4. 제목 끝에 마침표 X
  5. 제목은 명령문으로, 과거형 X
  6. 본문의 각 행은 72자 이내 (줄바꿈 사용)
  7. 본문은 어떻게 보다 무엇을, 왜에 대하여 설명

Commit message 구조

  • 기본적으로 제목, 본문, 꼬리말로 구성.
  • 제목은 필수사항이고, 본문과 꼬리말은 선택사항. : (<-여기까지 필수)

Type

  • Add : 새로운 기능 추가
  • Modify : 기존의 기능을 요구 사항에 맞추어 수정
  • Fix : 기능에 대한 버그 수정
  • Docs : 문서(주석) 수정
  • Style : 코드 스타일, 포맷팅에 대한 수정
  • Refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
  • Test : 테스트 코드 추가/수정
  • Etc : 기타 사항들

예시

Add: 로그인 api

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