CONTRIBUTING 가이드
오픈소스 프로젝트 기여 가이드라인 템플릿. 개발 환경 설정, 코드 스타일, PR 프로세스 포함.
기여 가이드
먼저 이 프로젝트에 관심을 가져주셔서 감사합니다! 🎉
행동 강령
이 프로젝트는 Contributor Covenant 행동 강령을 따릅니다. 참여하기 전에 반드시 읽어주세요.
기여 방법
버그 리포트
버그를 발견하셨나요? 이슈를 열어주세요.
좋은 버그 리포트에는 다음이 포함됩니다:
- 재현 가능한 최소한의 예시
- 예상 동작 vs 실제 동작
- 환경 정보 (OS, 버전 등)
기능 제안
새로운 기능 아이디어가 있으신가요? 기능 요청 이슈를 열어주세요. 구현 전에 먼저 논의하는 것을 권장합니다.
Pull Request
- 저장소를 포크하고 클론합니다
git clone https://github.com/YOUR_USERNAME/repo.git
cd repo
- 의존성을 설치합니다
npm install
- 기능 브랜치를 만듭니다
git checkout -b feature/your-feature-name
# 또는 버그 수정의 경우
git checkout -b fix/issue-description
- 변경사항을 작성하고 테스트합니다
npm test
npm run lint
- 커밋합니다 (Conventional Commits 형식 사용)
git commit -m "feat: add new feature"
git commit -m "fix: resolve login bug (#42)"
- 포크한 저장소에 푸시하고 PR을 생성합니다
개발 환경
요구 사항
- Node.js >= 18
- npm >= 9
로컬 개발
npm run dev # 개발 서버 시작
npm test # 테스트 실행
npm run test:watch # 감시 모드 테스트
npm run lint # 린트 검사
npm run lint:fix # 자동 수정
npm run build # 프로덕션 빌드
코드 스타일
커밋 메시지 규칙
Conventional Commits를 따릅니다:
| 접두사 | 설명 |
|---|---|
feat | 새로운 기능 |
fix | 버그 수정 |
docs | 문서 변경 |
style | 포맷팅 (기능 변경 없음) |
refactor | 리팩토링 |
test | 테스트 추가/수정 |
chore | 빌드, 설정 변경 |
질문이 있으신가요?
Discussions 또는 Discord에서 편하게 물어보세요.