Git Convention

🌿 GitHub Flow Convention

GitHub Flow는 단순하고 효과적인 브랜치 기반의 개발 전략입니다. 배포 중심의 애자일 개발에 적합하며, GitHub에서 널리 사용됩니다.

---

📌 기본 원칙

1. main 브랜치는 항상 배포 가능한 상태로 유지합니다.
2. 모든 작업은 기능 단위로 새로운 브랜치를 생성해서 진행합니다.
3. 작업이 완료되면 Pull Request(PR)를 생성하여 리뷰와 테스트를 거칩니다.
4. 리뷰가 완료되면 main 브랜치로 merge합니다.
5. Merge 후에는 자동 또는 수동으로 배포합니다.

---

🌿 브랜치 전략

1. 브랜치 네이밍 컨벤션

타입	접두어 예시	설명
기능	feat/login-form	새로운 기능 개발
버그 수정	fix/login-error	버그 수정 작업
리팩토링	refactor/auth-handler	코드 리팩토링
문서	docs/readme-update	문서 수정
테스트	test/login-unit-test	테스트 코드 추가
설정	chore/hilt-update	빌드, 설정 관련 작업

브랜치명은 타입/간단한-설명 형식을 따릅니다. 하이픈(-)을 사용해 읽기 쉽게 작성합니다. 브랜치명에는 관련 이슈 번호를 포함할 수 있습니다 (선택 사항).
예: feat/#15_login-form → 이슈 #15 관련 작업

---

🔀 Pull Request 규칙

• PR 제목 컨벤션

  [타입] #[이슈번호] 간단한 설명
  예: [Feat] #15 로그인 폼 UI 구현
  

• 관련 이슈

  • PR 설명 마지막에 다음 형식으로 작성:

    closes #이슈번호
    예: closes #15
    

  [타입] 간단한 설명
  예: [Feat] 로그인 폼 UI 구현
  

• PR 설명 템플릿 예시

  ## 작업 내용
  - 로그인 UI 폼 마크업 구현
  - 입력 필드 유효성 검사 추가
  
  ## 확인 방법
  - `/login` 경로에서 확인 가능합니다.
  
  ## 참고 사항
  - 추후 API 연동 필요
  
  ## 관련 이슈
  - closes #15

---

📦 Merge 정책

• 머지 방식: Merge Pull Request (커밋 히스토리 깔끔하게 유지) => Merge
• PR 리뷰 승인 후 직접 머지 (또는 Maintainer 권한자 머지)
• 머지 후 main 브랜치에 배포 자동화 연동 가능

---

🧪 배포 및 롤백

• main에 머지되면 배포 자동화(CI/CD)
• 문제가 발생하면 이전 릴리즈 태그 기준으로 hotfix 브랜치 생성 후 배포

---

🛠 예시 워크플로우

# 1. 메인 브랜치에서 최신 상태로 동기화
git checkout main
git pull origin main

# 2. 작업 브랜치 생성
git checkout -b feat/login-form

# 3. 작업 수행 및 커밋
git add .
git commit -m "feat: 로그인 폼 UI 구현"

# 4. 원격 저장소에 푸시
git push origin feat/login-form

# 5. GitHub에서 PR 생성 후 리뷰 & 머지

---

📚 참고 자료

• GitHub Flow 공식 문서
• Understanding the GitHub flow – GitHub Guides

---

📝 Git Commit Convention (Udacity Style)

커밋 메시지는 일관성과 가독성을 위해 Udacity에서 권장하는 형식을 따릅니다.

💡 커밋 메시지 구조

<type>: <subject>

• type은 커밋의 의도나 목적을 나타냅니다.
• subject는 간결하게 작업 내용을 설명합니다 (최대 50자 권장).

🔤 타입 목록

타입	설명
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
style	코드 포맷팅, 세미콜론 누락 등 기능에 영향 없는 변경
refactor	코드 리팩토링
test	테스트 코드 추가 및 수정
chore	빌드 작업, 패키지 매니저 설정 등 기타 변경

📌 커밋 예시

feat: 로그인 폼 마크업 및 기본 스타일 추가
fix: 로그인 실패 시 에러 메시지 표시 오류 수정
docs: README에 설치 가이드 추가
style: 코드 정렬 및 불필요한 공백 제거
refactor: auth 헬퍼 로직 분리 및 함수화
test: 로그인 유닛 테스트 추가
chore: eslint 설정 추가 및 적용

🚫 안 좋은 커밋 예시

커밋 메시지 없음
Update
fixing bug

---

✅ 커밋 작성 팁

• 명령형 문체로 작성 (Added ❌ → Add ✅)
• 간결하면서도 의미 있는 메시지 작성
• 하나의 커밋에는 하나의 목적만 담기

---