Skip to content

Latest commit

 

History

History
140 lines (100 loc) · 4.01 KB

File metadata and controls

140 lines (100 loc) · 4.01 KB

Git Workflow

1. Branch 전략

브랜치 용도 규칙
main 최종 배포 브랜치 직접 커밋 금지
dev 개발 통합 브랜치 PR을 통한 병합

기능 개발, 버그 수정, 문서 작업은 별도의 작업 브랜치에서 진행 후 dev 브랜치로 PR을 생성합니다.

Branch 네이밍

type/#이슈번호/작업내용
작업 유형 브랜치 규칙 예시
기능 개발 feat/#이슈번호/기능명 feat/#12/login-ui
버그 수정 fix/#이슈번호/버그명 fix/#21/login-error
문서 작업 docs/#이슈번호/문서명 docs/#3/convention
리팩토링 refactor/#이슈번호/작업명 refactor/#18/auth-cleanup

작업 브랜치는 생성된 Issue 번호를 기준으로 만듭니다.

2. Commit Convention

Udacity Git Commit Message Style Guide를 기반으로 합니다.

형식

type: 작업 내용
feat: 로그인 UI 구현
fix: 로그인 에러 처리 수정
docs: 프론트엔드 컨벤션 문서 추가
refactor: 인증 관련 로직 분리

커밋 메시지와 PR 제목에는 이슈번호를 넣지 않습니다. 이슈 연결은 PR 본문의 관련 이슈 section(close #이슈번호)에서 다룹니다.

작성 규칙

  • : 앞에는 공백을 넣지 않습니다.
  • : 뒤에는 공백 한 칸을 넣습니다.
  • 커밋 메시지는 한글로 작성합니다.
  • 작업 내용은 짧고 명확하게 작성합니다.
  • 하나의 커밋에는 하나의 작업 단위만 담는 것을 권장합니다.
  • 커밋 메시지는 명사형으로 작성합니다.

Commit Type

타입 의미
feat 새로운 기능, UI 추가
fix 버그 수정
docs 문서 작성 및 수정
refactor 기능 변화 없는 코드 구조 개선
style 동작에 영향 없는 스타일·마크업 변경
chore 설정, 패키지, 기타 작업
rename 파일명 또는 폴더명 변경
remove 파일 또는 코드 삭제

3. Pull Request Convention

PR 생성 규칙

  • 작업 브랜치에서 dev 브랜치로 PR을 생성합니다.
  • main 브랜치로 직접 PR을 생성하지 않습니다.
  • PR 제목은 커밋 메시지 형식과 동일하게 작성합니다.
feat: 로그인 UI 구현
fix: 캘린더 스크롤 오류 수정

PR 본문 작성

## 작업 내용

- 로그인 페이지 UI 구현
- 이메일/비밀번호 입력 폼 추가

## 관련 이슈

- close #12

## 참고 사항

- UI 변경 사항 확인을 위한 스크린샷 첨부

UI 변경이 있는 경우 스크린샷을 첨부합니다.

PR 병합 규칙

  • 최소 1명 이상 리뷰 후 병합합니다.
  • 충돌 발생 시 PR 작성자가 해결합니다.
  • 리뷰어를 등록합니다.
  • 리뷰 반영을 완료한 뒤 병합합니다.
  • 병합 전 불필요한 console.log, 주석, 테스트 코드를 확인합니다.

4. Issue Convention

모든 작업은 Issue를 생성한 뒤 진행합니다.

Issue 제목 형식

[type] 작업 내용
[feat] 로그인 화면 구현
[fix] 캘린더 스크롤 오류 수정
[docs] 프론트엔드 컨벤션 정리

Issue 템플릿

feature/refactor/bug/chore 이슈 템플릿은 .github/ISSUE_TEMPLATE/에서 관리합니다. 기능 작업은 커밋 타입과 Issue 제목에서는 feat를 사용하고, 템플릿 파일명은 feature.md를 사용합니다.

5. 작업 진행 순서

Issue 생성
→ 작업 브랜치 생성
→ 기능 개발
→ 커밋
→ dev 브랜치로 PR 생성
→ 코드 리뷰
→ 병합