📖 Commit Convention

Commit Convention - 타입

다음은 커밋 메시지에서 사용할 수 있는 타입의 예입니다:

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 포맷팅, 세미콜론 누락 등 (기능 변경 없음)
• refactor: 코드 리팩토링 (기능 변경 없음)
• perf: 성능 개선
• test: 테스트 추가 또는 수정
• chore: 빌드 작업, 패키지 매니저 수정 등 (소스 코드 변경 없음)
• ci: CI/CD 설정 수정
• build: 빌드 시스템 수정
• revert: 이전 커밋 되돌리기

Commit Convention - 제목

• 제목은 50자를 넘지 않아야 하며, 첫 글자는 대문자로 시작합니다.
• 제목은 명령문 형식으로 작성합니다.
• 제목 끝에 마침표를 사용하지 않습니다.

Commit Convention - 본문

• 본문은 필요에 따라 자세한 설명을 제공합니다.
• 본문은 72자를 넘지 않는 한 줄로 구성되며, 각 줄은 간결하게 작성합니다.
• 변경 사항의 배경, 목적 및 영향 등을 설명합니다.

Commit Convention - 푸터

푸터는 이슈 트래커의 이슈 번호를 참조하는 데 사용됩니다. 예를 들어, Closes #123 형식으로 작성합니다.

예시

커밋 메시지 예시

• feat: add login functionality(auth)
• fix: correct button alignment(user)
• docs: update installation instructions(REAMD.md)
• style: format code with Prettier
• refactor: improve performance of data fetching(bid)
• perf: optimize image loading
• test: add unit tests for user service(api)
• chore: update dependency versions
• ci: configure GitHub Actions
• build: update webpack configuration
• revert: remove unused feature