Skip to content

Commit c33930a

Browse files
committed
추가: 기여 가이드라인 작성
1 parent 1326488 commit c33930a

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

CONTRIBUTING.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# 기여 가이드라인
2+
3+
CCXT MCP 프로젝트에 관심을 가져주셔서 감사합니다! 이 프로젝트는 커뮤니티의 기여를 통해 더 나아질 수 있습니다. 다음 가이드라인은 개발에 참여하고자 하는 분들을 위한 것입니다.
4+
5+
## 기여 방법
6+
7+
다음과 같은 방법으로 프로젝트에 기여하실 수 있습니다:
8+
9+
1. **버그 리포트**: GitHub 이슈를 통해 발견한 버그를 제보해 주세요.
10+
2. **기능 요청**: 새로운 기능 아이디어가 있다면 GitHub 이슈를 통해 제안해 주세요.
11+
3. **코드 기여**: Pull Request를 통해 직접 코드를 기여해 주세요.
12+
4. **문서 개선**: README나 코드 문서화에 기여해 주세요.
13+
5. **사용 사례 공유**: 이 도구를 사용하는 창의적인 방법을 공유해 주세요.
14+
15+
## 개발 환경 설정
16+
17+
```bash
18+
# 저장소 클론
19+
git clone https://github.com/lazy-dinosaur/ccxt-mcp.git
20+
21+
# 프로젝트 디렉토리로 이동
22+
cd ccxt-mcp
23+
24+
# 의존성 설치
25+
npm install
26+
27+
# 개발 모드 실행
28+
npm run dev
29+
```
30+
31+
## Pull Request 과정
32+
33+
1. 먼저 GitHub에서 저장소를 포크하세요.
34+
2. 포크한 저장소를 로컬에 클론하세요.
35+
3. 기능별로 브랜치를 만드세요 (예: `feature/new-exchange-support`).
36+
4. 변경사항을 커밋하세요.
37+
5. GitHub에 변경사항을 푸시하세요.
38+
6. GitHub에서 원본 저장소로 Pull Request를 만드세요.
39+
40+
## Pull Request 체크리스트
41+
42+
PR을 제출하기 전에 다음 사항을 확인해 주세요:
43+
44+
- [ ] 코드가 TypeScript 코딩 스타일을 따르는지 확인
45+
- [ ] 필요한 테스트를 추가했는지 확인
46+
- [ ] 모든 테스트가 통과하는지 확인
47+
- [ ] 필요한 문서를 업데이트했는지 확인
48+
- [ ] PR이 단일 책임 원칙을 따르는지 (한 PR에 한 가지 기능/수정사항)
49+
50+
## 코딩 스타일
51+
52+
- TypeScript 코딩 규칙을 따릅니다.
53+
- 두 칸 들여쓰기를 사용합니다.
54+
- 명확한 변수 및 함수 이름을 사용합니다.
55+
- JSDoc 형식의 주석을 추가합니다.
56+
57+
## 커밋 메시지 가이드라인
58+
59+
커밋 메시지는 다음과 같은 형식을 따라주세요:
60+
61+
```
62+
유형: 간략한 변경사항 설명
63+
64+
상세 변경 내용 설명 (필요한 경우)
65+
```
66+
67+
유형:
68+
- `feat`: 새로운 기능
69+
- `fix`: 버그 수정
70+
- `docs`: 문서 변경
71+
- `style`: 코드 스타일 변경
72+
- `refactor`: 코드 리팩토링
73+
- `test`: 테스트 관련 변경
74+
- `chore`: 빌드 프로세스나 도구 변경
75+
76+
예시:
77+
```
78+
feat: 바이낸스 선물 시장 지원 추가
79+
80+
- 바이낸스 선물 시장 API 연동
81+
- 레버리지 설정 기능 구현
82+
- 포지션 관리 기능 추가
83+
```
84+
85+
## 라이센스
86+
87+
이 프로젝트에 기여함으로써, 귀하의 기여물이 MIT 라이센스의 조건에 따라 배포된다는 것에 동의하게 됩니다.
88+
89+
## 연락처
90+
91+
질문이 있으시면 언제든지 GitHub 이슈를 통해 문의하거나 직접 이메일을 보내주세요.
92+
93+
감사합니다!

0 commit comments

Comments
 (0)