📝 커밋 메시지 컨벤션

<aside> ✅

1. 커밋 유형 지정

• 커밋 유형은 영어 대문자로 작성한다

2. 제목과 본문을 빈행으로 분리

• 커밋 유형 이후 제목과 본문은 한글로 작성하여 내용이 잘 전달될 수 있도록 할 것
• 본문에는 변경한 내용과 이유 설명 (어떻게보다는 무엇 & 왜를 설명)

3. 제목 첫 글자는 대문자로, 끝에는 . 금지

4. 제목은 영문 기준 50자 이내로 할 것

5. 자신의 코드가 직관적으로 바로 파악할 수 있다고 생각하지 말자

6. 여러가지 항목이 있다면 글머리 기호를 통해 가독성 높이기

- 변경 내용 1
- 변경 내용 2
- 변경 내용 3

</aside>

🌿 브랜치 전략 & 네이밍 컨벤션

<aside> ✅

1. 브랜치 전략

• main 브랜치는 배포용(branch protection 적용) 으로 직접 커밋하거나 푸시하지 않는다. (Lock)
• 모든 개발은 develop 브랜치를 기준으로 이루어진다.
• 기능 단위로 develop에서 브랜치를 파생하여 작업하고, 작업 완료 후 develop 브랜치에 병합한다.
• 병합 전에는 Pull Request(PR) 를 통해 코드 리뷰 과정을 거친다.

2. 브랜치 네이밍 규칙

• 브랜치 이름은 영문 소문자로 작성하고, 슬래시(/)를 이용해 유형/기능 형태로 명시한다.

예시:

• feature/mainPage: 메인 페이지 기능 개발
• fix/loginError: 로그인 오류 수정
• refactor/navbar: 내비게이션 리팩토링

3. 브랜치 병합 흐름

1. develop 브랜치로부터 기능 브랜치를 생성
2. 브랜치에서 개발 작업 수행
3. 작업 완료 후, develop 브랜치에 Pull Request 생성
4. 코드 리뷰 및 테스트 완료 후 develop 브랜치에 병합
5. 주요 배포 시점에 develop 브랜치를 main 브랜치에 병합 (배포 태그 포함)

4. 주의사항

• main 브랜치에는 직접 푸시 금지 (보호 설정 필수)
• 브랜치 이름은 간결하고 명확하게 작성
• 커밋 메시지는 커밋 메시지 컨벤션에 따를 것
• 여러 작업을 한 브랜치에 몰아서 작업하지 말고, 기능별로 분리할 것

5. 예시 브랜치 시나리오

# 기능 브랜치 생성
git checkout develop
git checkout -b feature/signupPage

# 작업 완료 후
git add .
git commit -m "Feat: 회원가입 페이지 UI 구성"

# 원격에 기능 브랜치 push
git push origin feature/signupPage

# develop 브랜치에 PR 생성
# 코드리뷰 후 merge

</aside>

🌿 이슈 관리 전략 & 사용법

<aside> ✅

1. 이슈 생성 및 관리 원칙

• 모든 작업(기능 개발, 버그 수정, 문서 작업 등)은 반드시 이슈(issue)로 등록하여 관리한다.
• 이슈는 작업의 목적, 범위, 예상 결과를 명확히 작성한다.
• 이슈는 작업 유형에 따라 label(예: feature, bug, docs 등)을 지정한다.

2. 이슈 생성 방법

1. GitHub(또는 사용하는 Git 플랫폼)에서 New Issue 버튼을 클릭한다.
2. 제목은 간결하게, 내용에는 작업 목적 및 상세 설명을 작성한다.
3. 적절한 label을 선택하고, 필요하다면 assignee(담당자)를 지정한다.

3. 브랜치와 이슈 연결

여기서 오른쪽 하단에 create a branch 클릭

branch source는 develop으로 설정 후 생성

git fetch origin
git checkout feature/mainPage

해당 명령어 터미널에 복붙 후 브랜치 사용

4. 이슈와 Pull Request(PR) 연결

• 작업 완료 후, develop 브랜치로 Pull Request를 생성한다.
• PR 제목 또는 설명에 Closes #이슈번호 또는 Fixes #이슈번호를 명시하여 PR이 병합되면 이슈가 자동으로 닫히도록 한다.
• 코드 리뷰 및 테스트 완료 후 develop 브랜치에 병합한다.

</aside>

🏷️ Git 태그(Tag) 사용 가이드

<aside> ✅

</aside>