CONTRIBUTING.md

기여 가이드라인

CCXT MCP 프로젝트에 관심을 가져주셔서 감사합니다! 이 프로젝트는 커뮤니티의 기여를 통해 더 나아질 수 있습니다. 다음 가이드라인은 개발에 참여하고자 하는 분들을 위한 것입니다.

기여 방법

다음과 같은 방법으로 프로젝트에 기여하실 수 있습니다:

1. 버그 리포트: GitHub 이슈를 통해 발견한 버그를 제보해 주세요.
2. 기능 요청: 새로운 기능 아이디어가 있다면 GitHub 이슈를 통해 제안해 주세요.
3. 코드 기여: Pull Request를 통해 직접 코드를 기여해 주세요.
4. 문서 개선: README나 코드 문서화에 기여해 주세요.
5. 사용 사례 공유: 이 도구를 사용하는 창의적인 방법을 공유해 주세요.

개발 환경 설정

# 저장소 클론
git clone https://github.com/lazy-dinosaur/ccxt-mcp.git

# 프로젝트 디렉토리로 이동
cd ccxt-mcp

# 의존성 설치
npm install

# 개발 모드 실행
npm run dev

Pull Request 과정

1. 먼저 GitHub에서 저장소를 포크하세요.
2. 포크한 저장소를 로컬에 클론하세요.
3. 기능별로 브랜치를 만드세요 (예: feature/new-exchange-support).
4. 변경사항을 커밋하세요.
5. GitHub에 변경사항을 푸시하세요.
6. GitHub에서 원본 저장소로 Pull Request를 만드세요.

Pull Request 체크리스트

PR을 제출하기 전에 다음 사항을 확인해 주세요:

• 코드가 TypeScript 코딩 스타일을 따르는지 확인
• 필요한 테스트를 추가했는지 확인
• 모든 테스트가 통과하는지 확인
• 필요한 문서를 업데이트했는지 확인
• PR이 단일 책임 원칙을 따르는지 (한 PR에 한 가지 기능/수정사항)

코딩 스타일

• TypeScript 코딩 규칙을 따릅니다.
• 두 칸 들여쓰기를 사용합니다.
• 명확한 변수 및 함수 이름을 사용합니다.
• JSDoc 형식의 주석을 추가합니다.

커밋 메시지 가이드라인

커밋 메시지는 다음과 같은 형식을 따라주세요:

유형: 간략한 변경사항 설명

상세 변경 내용 설명 (필요한 경우)

유형:

• feat: 새로운 기능
• fix: 버그 수정
• docs: 문서 변경
• style: 코드 스타일 변경
• refactor: 코드 리팩토링
• test: 테스트 관련 변경
• chore: 빌드 프로세스나 도구 변경

예시:

feat: 바이낸스 선물 시장 지원 추가

- 바이낸스 선물 시장 API 연동
- 레버리지 설정 기능 구현
- 포지션 관리 기능 추가

라이센스

이 프로젝트에 기여함으로써, 귀하의 기여물이 MIT 라이센스의 조건에 따라 배포된다는 것에 동의하게 됩니다.

연락처

질문이 있으시면 언제든지 GitHub 이슈를 통해 문의하거나 직접 이메일을 보내주세요.

감사합니다!