Contributing to Hearus

Hearus 프로젝트에 관심을 가져주셔서 감사합니다!
이 문서는 프로젝트에 기여하는 방법에 대한 가이드라인을 제공합니다.

행동 강령

본 프로젝트는 Contributor Covenant를 채택하고 있습니다.
프로젝트에 참여함으로써 이 행동 강령을 준수할 것을 동의하는 것으로 간주됩니다.

기여 프로세스

1. 프로젝트를 Fork 합니다.
2. 자신의 로컬 머신에 프로젝트를 Clone 합니다.
3. 새로운 브랜치를 생성합니다.
4. 변경사항을 작업합니다.
5. 변경사항을 커밋하고 푸시합니다.
6. Pull Request를 생성합니다.

브랜치 전략

• main: 안정적인 프로덕션 코드
• develop: 개발 중인 코드
• 기능 브랜치: feature/, bug/, chore/, refactor/

브랜치 명명 규칙:

• 각 브랜치는 develop 브랜치로부터 {타입}/{기능명}으로 생성합니다.
• 기능명에 공백이 필요한 경우 -로 구분합니다.

예시:

• feature/login
• chore/update-dependencies
• bug/signup-form-validation

타입:

• INIT: 프로젝트 초기화
• ADD, FEAT: 새로운 기능 추가
• FIX: 버그 수정
• REFACTOR: 리팩토링
• UPDATE, CHORE: 기타 변경사항 (빌드 스크립트 수정, assets, 패키지 매니저 등)
• DESIGN: 디자인 (UI 컴포넌트 생성 및 변경 등)

커밋 규칙

커밋 메시지 형식:

[Type]: subject

body (선택사항)

예시:

feat: 회원가입 및 로그인 기능 추가

회원가입 기능, 로그인 기능 추가

Pull Request 가이드라인

PR 제목 규칙

<TYPE>: {수정 내용}

타입은 대문자로 작성합니다.

예시: FEAT: 회원가입 및 로그인 기능 추가

PR 내용 규칙

## 요약(Summary)
// 작업한 부분에 대한 간단한 요약

## 변경 사항(Changes)
// 기존과 비교했을 때 해당 PR에서 변경된 내용
// 어떤 부분을 왜 수정했는지 작성

## 리뷰 요구사항
// 해당 PR에서 중점적으로 혹은 꼭 리뷰가 필요한 사항들
// 체크리스트 등 자유 형식으로 작성

## 확인 방법 (선택)
// 화면 스크린샷, 기능 구동 gif 등 작업 결과를 한 눈에 볼 수 있는 자료

코드 리뷰

• 모든 PR은 최소 1명 이상의 리뷰어의 승인이 필요합니다.
• 리뷰어는 코드 품질, 기능의 적절성, 테스트 커버리지 등을 검토합니다.
• 건설적이고 존중하는 피드백을 제공해주세요.

문서화

• 새로운 기능을 추가할 때는 관련 문서도 함께 업데이트해주세요.
• 코드 내 주석은 간결하고 명확하게 작성해주세요.

테스트

• 새로운 기능이나 버그 수정 시 관련 테스트 코드를 함께 작성해주세요.
• 모든 테스트가 통과하는지 확인 후 PR을 제출해주세요.

이슈 보고하기

버그를 발견하거나 새로운 기능을 제안하고 싶다면, GitHub Issues를 이용해 주세요.
이슈 템플릿을 사용하여 필요한 정보를 모두 포함해주세요.

여러분의 기여는 Hearus 프로젝트를 더욱 발전시키는 데 큰 도움이 됩니다.