Skip to content

kmu-koss/Team_RoKo_2020

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

Git Commit Rules

1. Commit Messages Structure

Type: Subject
body
footer

2. Commit Type

Type 키워드 사용 시점
feat 새로운 기능 추가
fix 버그 수정
docs 문서 수정
style 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)기능 수정이 없는 경우
design 사용자 UI 디자인 변경 (CSS 등)
test 테스트 코드, 리팩토링 테스트 코드 추가
refactor 코드 리팩토링
build 빌드 파일 수정
ci CI 설정 파일 수정
perf 성능 개선
chore 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)
rename 파일 혹은 폴더명을 수정한 경우 또는 옮기는 경우
remove 파일을 삭제만 한 경우
comment 필요한 주석 추가 및 변경

3. Title

  • 제목은 50자를 넘기지 않고, 마침표를 붙이지 않는다.
  • 제목에는 위 커밋 종류를 함께 쓴다.
  • 과거시제를 사용하지 않고 명령조로 작성한다.
  • 제목과 본문은 한 줄 띄워 분리한다.
  • 제목의 첫 글자는 반드시 대문자로 쓴다.
  • 제목이나 본문에 이슈 번호(가 있다면) 붙여야 한다.

4. Body

  • 선택사항이기에 모든 커밋에 본문 내용을 작성할 필요는 없다.
  • 한 줄에 72자를 넘기면 안된다.
  • 어떻게(How)보다 무엇을, 왜(What, Why)에 맞춰 작성한다.
  • 설명뿐만 아니라, 커밋의 이유를 작성할 때에도 쓴다.

5. Footer

  • 선택사항이기에 모든 커밋에 꼬릿말을 작성할 필요는 없다.
  • Issue Tracker ID를 작성할 때 사용한다.

커밋 메세지 규칙 요약

  • 제목과 본문을 빈 행으로 구분
  • 제목은 영문 기준 50글자 이하
  • 첫 글자는 대문자로 작성
  • 제목 끝에 마침표X
  • 제목은 명령문으로 사용, 과거형X
  • 본문의 각 행은 영문 기준 72글자 이하
  • 어떻게 보다는 무엇과 왜

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages