기여 방법 (Contributing Guide)

기여 방법 (Contributing Guide)

기본 원칙

1. 작업 전 Github Projects 탭에서 이슈 생성 → 기본 필드 지정을 먼저 해주세요
2. 브랜치를 생성하기 전에 origin develop 을 Pull 해서 develop 브랜치를 업데이트해주세요
3. 이슈가 만들어지면 prefix#이슈번호 규칙으로 브랜치를 생성합니다
4. 작업은 develop(default) 브랜치에서 분기합니다
5. 작업 완료 후 PR 을 통해 만든 이슈를 링크하고, 리뷰어 지정 → 승인 후 머지합니다

Note

이슈 먼저 만들고, 부여된 이슈 번호로 브랜치를 파서 작업하세요.
예) 이슈 #12라면: feature#12, fix#12

브랜치 네이밍 컨벤션

Git Flow

• 기본(디폴트) 브랜치는 develop 브랜치를 사용해요
• 기능/수정 등은 develop에서 분기 → PR → develop로 병합해요

작업 유형	Prefix	예시(이슈 #)
기능 개발	feature	feature#1
버그 수정	fix	fix#2
리팩토링	refactor	refactor#3
문서 작업	docs	docs#4
테스트	test	test#5
기타(환경/빌드 등)	chore	chore#6

Tip

Git Flow 전략에 대해 더 궁금하면
우린 Git-Flow 를 사용하고 있어요 - 우아한기술블로그를 참고해주세요

브랜치 생성 예시

git checkout develop
git pull origin develop

git checkout -b feature#123

PR 병합 예시

develop ──┐
          ├── feature#12 → PR → 리뷰/승인 → develop 머지
          └── fix#34     → PR → 리뷰/승인 → develop 머지

커밋 컨벤션

기본 규칙

• type: 작업 내용에 대한 설명
• 필요시 본문(body)에 변경 이유 및 세부사항을 추가할 수 있어요

커밋 type

type	의미
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
refactor	코드 리팩토링(기능 변경 없음)
test	테스트 코드 추가/수정
chore	환경/빌드 등

커밋 메시지 예시

1. 단문형

feat: 회원가입 폼 유효성 검증 추가

2. 본문 포함형

fix: 모바일 사파리에서 결제창 리다이렉트 버그 수정

- iOS 16 환경에서 window.open 블로킹 문제 대응
- 결제 완료 후 close 타이밍 지연