Skip to content

Commit Convention Guide

Taehyeon Kim edited this page Oct 13, 2022 · 5 revisions

Result

[#5] 흡연 구역 노출 기능 구현
  • [#이슈넘버] + 내용으로 커밋 메시지를 구성합니다.
  • 내용은 보는 사람이 이해할 수 있도록 최대한 구체적으로 작성합니다.

Discussion

Prefix Description
Feat 새로운 기능 추가
Fix 버그 수정
Docs 문서 (README, 포팅 매뉴얼)
Test 테스트 코드
Refactor 코드 리팩토링 (성능 개선만 해당)
Style 코드 의미에 영향을 주지 않는 변경사항
Chore 빌드, 설정 파일
Comment 주석이 추가되는 경우
Build 빌드 관련 파일 수정

기존에는 위의 표에서 확인가능한 Prefix를 이용해서 Commit을 작성해왔습니다.

[FEAT] 흡연 구역 노출 기능 구현 (#23)

다음 지점에서 Prefix를 사용할 필요가 있을까라는 의문이 들었습니다.

  1. Prefix를 구분하는데에 있어 그 경계가 모호함이 존재합니다.
    • Feat, Style, Chore 등의 경계가 모호한 작업들이 존재합니다.
    • 모호함이 존재한다는 것은 잘못된 Prefix를 기입할 수 있다는 내용을 포함합니다.
  2. 일반적으로 내용에 이미 Prefix의 의미가 내포되어 있습니다.
Clone this wiki locally