👮🏻 깃허브 컨벤션

1. Issue

이슈 템플릿에 맞춰 작성하고, 이슈 제목은 한글로 저장해요.

---
name: Feature Template
about: project's features
title: ''
labels: ''
assignees: ''
---

## 📂 구현 기능

1-2문장으로 요약. 

## 📝 상세 작업 내용 

- [ ] 
- [ ] 

## 🔆 참고 사항 (선택)

## ⏰ 예상 작업 시간

2. Branch

브랜치는 Git Flow 전략에 맞게 사용해요.

• main: 제품 출시 브랜치
  • hotfix: 출시 버전에서 발생한 버그 수정 브랜치
• develop: 출시를 위해 개발하는 브랜치
  • feature: 새로운 기능을 개발하는 브랜치 (feature/#이슈번호)
  • release: 이번 출시 버전을 준비하는 브랜치

3. Commit

기본 형식은 ${commit type}: ${commit message} - #${이슈번호} 을 사용해요.

• commit type 소문자
• commit message 첫 글자 꼭 대문자

예시 : feat: Implement login - #1

Commit Tag 규칙

Tag Name	Description
feat	새로운 기능을 추가 혹은 변경
fix	버그 수정
design	CSS 관련 사용자 UI 디자인 변경
style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
chore	빌드 테스크 업데이트, 패키지 매니저 환경설정, 프로덕션 코드 변경 없음, 파일 구조 변경
refactor	프로덕션 코드 리팩토링
comment	필요한 주석 추가 및 변경
docs	문서 수정
test	테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음

4. Pull Request

1. Pull Request 제목은 이슈 제목과 동일하게 작성해요.
2. 아래 PR 템플릿에 따라 내용을 작성해서 요청을 보내요.

## 📂 작업 내용

closes #이슈번호

- [x] 작업 내용

## 💡 자세한 설명

(가능한 한 자세히 작성해 주시면 도움이 됩니다.)

## 📗 참고 자료 & 구현 결과 (선택)

## 📢 리뷰 요구 사항 (선택)

## 🚩 후속 작업 (선택)

## ✅ 셀프 체크리스트

- [ ] PR 제목을 형식에 맞게 작성했나요?
- [ ] 브랜치 전략에 맞는 브랜치에 PR을 올리고 있나요? (`main`이 아닙니다.)
- [ ] 이슈는 close 했나요?
- [ ] Reviewers, Labels를 등록했나요?
- [ ] 작업 도중 문서 수정이 필요한 경우 잘 수정했나요?
- [ ] 테스트는 잘 통과했나요?
- [ ] 불필요한 코드는 제거했나요?

5. Merge

Merge 방식은 Create a merge commit 을 사용해요.

• 일반 merge commit은 feature 개발의 전체 맥락을 보존하기 좋아 선택했어요.
• 추후 모든 커밋 로그를 분석하고자 선택했어요.

Approve : 2주차에는 먼저 4명 리뷰 도전! 하고 3주차부터 조정해 보아요.

Merge Conflict: 해당 스토리 - 태스크 담당자와 함께 Merge 해요.

6. Github Project 진행 상태

• 🎒 Product Backlog : 요구사항 정의와 함께 노션에 정리
• 📋 Backlog(Sprint) : 스프린트 백로그로서 마일스톤(주차)별 개발할 기능과 작업을 추가
• 🔖 Ready : 당일 해야 할 작업
• 🏗 In progress : 현재 진행 중인 작업
• 👀 In review : 현재 리뷰 중 ⇒ PR에서 리뷰가 필요한 경우
• ✅ Done : Merge 완료!