컨벤션

Git

Branch Convention

feature branch

• 어떤 이름도 가능하다. 단, master, develop, release-..., hotfix-... 같은 이름은 사용할 수 없다.
• feature/기능요약 형식을 추천한다. ex) feature-login
• feature/{issue-number}/{feature-name} 이슈추적을 사용한다면 이와 같은 형식을 따른다.

Commit Convention

• message는 해당 commit의 역할을 간결하고 정확하게 전달할 수 있어야 합니다.

[필수] type

commit의 종류를 뜻합니다. 소문자로만 작성합니다.

• feat: 기능 추가
• fix: 버그 패치, 오류 수정
• docs: 문서 관련 작업 (markdown 등)
• style: 코드의 심미적인 변경(줄바꿈, 스페이싱, 세미콜론 추가 등 기능 변경 없는 것)
• refactor: 코드 리팩토링(변수 명 변경 등)
• chore: 빌드 작업, 패키지 매니저 관련 수정
• test: 테스트 코드 관련
• perf: 코드 성능 최적화, 속도 향상
• ci: CI 관련 작업
• form : 주석관련 작업

[선택] scope

commit의 적용 영역을 뜻합니다. type 옆에 괄호를 사용하여 소문자로만 작성합니다.

• deps: 디펜던시, 의존 모듈
• core: 코어, 핵심 기능
• docs: md와 같은 문서

[필수] colon

: (콜론)은 type과 subject를 나누는 구분자 역할입니다.

띄어쓰기는 콜론과 subject 사이에만 합니다. type과 콜론 사이에는 띄어쓰지 않습니다.

[필수] subject

commit의 제목입니다. 50자 이내의 길이를 지향하며, 첫 글자는 반드시 대문자여야 합니다.

마침표는 사용하지 않고, 과거형이나 ing 등을 붙이지 않고 명령조로 작성하는 것이 원칙입니다.

• Modify: 수정
• Delete: 삭제
• Add: 생성, 추가
• Update: 업데이트
• Revert: 작업 취소

Commit Message 예시

• 다양한 semantic commit message 예시

✅ ex) **fix**: **R**emove wrong page 'myPage1'

❌ ex) fix : Remove wrong page 'myPage1'  -  colon 왼쪽은 띄어쓰지 않습니다.

❌ ex) fix: removed wrong page 'myPage1'  -  subject의 첫 글자는 대문자여야 합니다.

❌ ex) fix: Removed wrong page 'myPage1'  -  과거형으로 작성하지 않습니다.

❌ ex) Fix: Remove wrong page 'myPage1'  -  type은 소문자로만 작성합니다.

Develop

Naming Convention

	컨벤션
JAVA	camel,pascal
JavaScript	camel,pascal
DataBase	snake
상수	scream snake
html , css	kebab
API URL	kebab

변수명과 함수명에는 Camel Case

camelCaseNamingConvention

클래스명에는 Pascal Case

PascalCaseNamingConvention

예시

• Snake Case : snake_case_naming_convention
• Camel Case : camelCaseNamingConvention
• Pascal Case : PascalCaseNamingConvention
• kebab Case : kebab-case-naming-convention
• Scream Snake Case : SCREAM_SNAKE_CASE_EXAMPLE