Skip to content

기여하기

MoAI-ADK 프로젝트에 관심을 가져주셔서 감사합니다. 여러분의 기여가 프로젝트를 더욱 강력하게 만듭니다.

기여 방법

버그 리포트

버그를 발견하셨나요? GitHub Issues를 통해 알려주세요:

  1. 검색: 이미 보고된 버그가 있는지 확인
  2. 상세 정보: 재현 단계, 환경 정보, 스크린샷 포함
  3. 최소화 예제: 문제를 보여주는 최소한의 코드

기능 제안

새로운 기능 아이디어가 있으시다면:

  1. 문제 정의: 어떤 문제를 해결하는지 명확히 설명
  2. 해결책: 제안하는 해결책의 장단점 분석
  3. 대안: 다른 가능한 해결책 고려

코드 기여

코드로 직접 기여하고 싶으시다면:

  1. Fork: 저장소를 fork합니다
  2. 브랜치: 기능별로 브랜치를 생성합니다 (git checkout -b feature/amazing-feature)
  3. 커밋: 변경사항을 커밋합니다 (git commit -m 'Add amazing feature')
  4. 푸시: 브랜치를 푸시합니다 (git push origin feature/amazing-feature)
  5. PR: Pull Request를 생성합니다

개발 환경 설정

1. 저장소 클론

git clone https://github.com/modu-ai/moai-adk.git
cd moai-adk

2. 개발 환경 설치

# UV 사용 (권장)
uv sync

# 또는 pip 사용
pip install -e ".[dev]"

3. 테스트 실행

pytest

# 커버리지 포함
pytest --cov=moai_adk

4. 코드 스타일 검사

# 코드 포맷팅
black .
ruff check .
ruff format .

# 타입 검사
mypy .

문서 기여

문서 개선도 중요한 기여입니다:

  • 오타 수정: 발견한 오타나 문법 오류 수정
  • 번역: 다른 언어로 문서 번역
  • 예제 추가: 더 많은 사용 예제 추가
  • 설명 개선: 복잡한 개념을 더 명확하게 설명

코딩 표준

  • PEP 8: Python 스타일 가이드 준수
  • 타입 힌트: 모든 함수에 타입 힌트 포함
  • 독스트링: 모든 모듈과 함수에 독스트링 포함
  • 테스트: 새로운 기능에는 반드시 테스트 코드 포함

커뮤니티

  • GitHub Discussions: 질문과 토론
  • Issues: 버그 리포트와 기능 제안
  • Pull Requests: 코드 리뷰와 협업

라이선스

기여한 코드는 프로젝트의 MIT 라이선스 하에 배포됩니다.