[doc] Git Commit Convention

[gyuseok-dev]

Commit Formats

Default

<type>(<optional scope>):<subject>empty separator line<optional body>empty separator line<optional footer>

• subject와 body에는 한글/영어를 혼용 가능.

Types

• feat : 기획과 관련한 기능 추가 및 삭제
• fix  : 버그 수정 및 기존 기능 수정
• refactor : 리팩토링 (기능 수정 X) * 기능 수정과 리팩토링 구분해서 올려주세요.
  • perf : 성능 향상을 위한 리팩토링
• style : code style 변경 (white-space, formatting, missing semi-colons, etc)
• test : 테스트 추가
• docs : 문서 추가/변경 (ReadMe.md)
• build: 빌드 관련 변경 (build tool, ci pipeline, dependencies, project version)
• chore : 그외 변경 ( .gitignore )

Subject

The subject contains a succinct description of the change.

• required
• 한 줄에 59자 이하
• 추가, 변경, 수정, 삭제, 개선 등 명사형 문장으로 작성
• 끝에 온점(.) 생략
• ex) oo 기능 추가, 불필요한 코드 삭제

Body

• optional
• 한 줄에 59자 이하
• 추가, 변경, 수정, 삭제, 개선 등 명사형 문장으로 작성
• subject외에 더 자세한 내용이 필요하다면 작성

Examples

• feat: 엄청난 버튼 추가
• fix: <어떤 이유>인한 oo 컴포넌트 버그 수정
• fix: 오타 수정
• build: package.json dependency 업데이트
• refactor: oo 컴포넌트 구조 리팩토링
• style: white space 제거
• revert: refactor: oo 컴포넌트 구조 리팩토링 This reverts commit 221d3ec6ffeead67cee8c730c4a15cf8dc84897a.

---

• 프로젝트 규모를 고려하여 불필요한 부분은 일부 제거했습니다. 더 자세한 내용은 Refence에서 확인해주세요.

---

References

• https://www.conventionalcommits.org/
• https://github.com/angular/angular/blob/master/CONTRIBUTING.md
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html
• https://github.com/github/platform-samples/tree/master/pre-receive-hooks
• https://github.community/t5/GitHub-Enterprise-Best-Practices/Using-pre-receive-hooks-in-GitHub-Enterprise/ba-p/13863

[positiveko]

😇👍🏻