Git Convention

1. Git Convention

1.1. Rule

준수해야 할 규칙은 다음과 같습니다.

1. main, develop Branch에서의 작업은 원칙적으로 금지합니다. 단, README 작성은 develop Branch에서 수행합니다.
2. Commit, Push, Merge, Pull Request 등 모든 작업은 오류 없이 정상적으로 실행되는 경우에만 수행합니다.

1.2. Branch

Branch의 Naming Rule은 1.2.1.을 준수합니다.

1.2.1. Branch Naming Rule

<Prefix> 의 양식을 준수합니다. 단, feature Branch는 <Prefix>/<Jira_Ticket> 의 양식을 준수합니다.

1.2.2. Prefix

• main : 운영 프로덕트의 버전이 관리될 Branch 입니다.
• develop: feature Branch에서 구현된 기능들이 merge될 Default Branch 입니다.
• sandbox: feature Branch에서 작업 중인 기능들을 개발 서버로 배포하여 자유롭게 테스트할 수 있는 Branch입니다.
• feature: 기능을 개발하는 Branch 입니다. Jira Ticket 단위로 Branch를 생성합니다.

1.2.3. Example

feature/XPR-3-1

1.3. Commit

Commit의 Commit Message Convention은 1.3.1.을 준수합니다.

1.3.1. Commit Message Convention

<Jira_Ticket> <Prefix>: <Description> 의 양식을 준수합니다.

• feat : 새로운 기능 구현
• fix : 코드 오류 수정
• del : 불필요한 코드 삭제
• docs : README나 wiki 등의 문서 개정
• refactor : 내부 로직은 변경 하지 않고 기존의 코드를 개선하는 리팩터링
• chore : 의존성 추가, yml 추가와 수정, 패키지 구조 변경, 파일 이동 등의 작업
• test: 테스트 코드 작성, 수정

1.4. Pull Request

main, develop Branch로 Merge할 때는 Pull Request가 선행되어야 합니다. Pull Request에는 작업 내용을 명시합니다.

1.4.1 Pull Request Naming Rule

<Jira_Ticket> <Description> 의 양식을 준수합니다.

1.4.2. Example

XPR-1 프로젝트 초기 세팅

1.5. Code Review

Code Review는 다음 5가지 Rule을 준수하여 작성합니다.

• P1: 꼭 반영해주세요 (Request changes)
• P2: 적극적으로 고려해주세요 (Request changes)
• P3: 웬만하면 반영해 주세요 (Comment)
• P4: 반영해도 좋고 넘어가도 좋습니다 (Approve)
• P5: 그냥 사소한 의견입니다 (Approve)