[Github] 컨벤션 초간단 예시

 

1. 컨벤션 구성

 

<type> scope : summary

 

<type> 후 scope: 후 summary

 

 - type : 수정 분류

 - scope : 수정 범위로 기능, 서비스명이나 함수, 클래스명 등

 - summary : 수정 내용

 

 

 

 

 

2. <type> 종류

 

build : build system 혹은 external dependencies에 영향을 주는 변경이 있을 시
ci : CI configuration files나 scripts에 변경이 있을 시
docs : documentation만이 변경되었을 때
feat : 새로운 기능이 추가되었을 때
fix : 버그를 수정했을 때
perf : 코드의 성능을 향상시켰을 때
refactor : 버그를 수정하거나 기능을 추가하지 않고 코드 변경 시
test : 이미 존재하는 테스트 혹은 누락된 테스트를 추가했을 시
style : 세미 콜론 누락, 들여쓰기 수정, 포매팅 수정 등 스타일 관련 변경 시

chore : 기타 등등

 

 

 

 

 

3. scope 종류

 

 - 예시

 internal login

 external global rates

 internal usdkrw

 

 

 

 

 

4. summary

 

 - 예시

 일반 유저 로그인에 otp 인증 추가

 긴급 점검

 

 

 

 

 

5. 최종

 

<type> scope: summary

 

 - 예시

<feat> fun loginApple : 애플 소셜 로그인 기능 추가

<fix> class system : system 정보 일부 유실 오류 해결

<perf> code search : 코드 검색 기능 속도 개선