Ultralytics 오픈 소스 프로젝트에 기여하기

환영합니다! 저희의 오픈소스 프로젝트에 기여를 고려하고 계시다니 Ultralytics 오픈소스 프로젝트에 기여해 주셔서 기쁩니다. 여러분의 참여는 리포지토리의 품질을 향상시키는 데 도움이 될 뿐만 아니라 전체 커뮤니티에도 도움이 됩니다. 이 가이드는 시작하는 데 도움이 되는 명확한 가이드라인과 모범 사례를 제공합니다.

행동 강령

모두를 환영하고 포용하는 환경을 조성하기 위해 모든 기여자는 행동 강령을 준수해야 합니다. 존중, 친절, 전문성은 우리 커뮤니티의 핵심입니다.

풀 리퀘스트를 통한 기여

풀 리퀘스트 형태로 기여해 주시면 대단히 감사하겠습니다. 검토 프로세스를 최대한 원활하게 진행하려면 다음 단계를 따라주세요:

1. 리포지토리를 포크합니다: Ultralytics YOLO 리포지토리를 GitHub 계정으로 포크하여 시작하세요.

2. 브랜치를 만듭니다: 포크된 리포지토리에 변경 내용을 반영하는 명확하고 설명이 포함된 이름을 사용하여 새 브랜치를 만듭니다.

3. 변경합니다: 코드가 프로젝트의 스타일 가이드라인을 준수하고 새로운 오류나 경고를 유발하지 않는지 확인합니다.

4. 변경 사항을 테스트합니다: 제출하기 전에 로컬에서 변경 사항을 테스트하여 예상대로 작동하는지, 새로운 문제가 발생하지 않는지 확인하세요.

5. 변경 내용을 커밋합니다: 간결하고 설명적인 커밋 메시지로 변경 내용을 커밋하세요. 변경 사항이 특정 이슈를 해결하는 경우 커밋 메시지에 이슈 번호를 포함하세요.

6. 풀 리퀘스트를 만듭니다: 포크된 리포지토리에서 메인 리포지토리( Ultralytics YOLO )로 풀 리퀘스트를 제출합니다. 변경 사항과 변경 사항이 프로젝트를 어떻게 개선하는지 명확하고 상세하게 설명하세요.

CLA 서명

풀 리퀘스트를 병합하려면 먼저 기여자 라이선스 계약(CLA)에 서명해야 합니다. 이 법적 계약은 여러분의 기여에 적절한 라이선스가 부여되어 프로젝트가 AGPL-3.0 라이선스에 따라 계속 배포될 수 있도록 보장합니다.

풀 리퀘스트를 제출하면 CLA 봇이 서명 절차를 안내합니다. CLA에 서명하려면 PR에 코멘트를 추가하기만 하면 됩니다:

I have read the CLA Document and I sign the CLA

Google-스타일 문서 문자열

새 함수나 클래스를 추가할 때는 Google-스타일의 문서 문자열을 포함하세요. 이러한 문서 문자열은 다른 개발자가 코드를 이해하고 유지 관리하는 데 도움이 되는 명확하고 표준화된 문서를 제공합니다.

def example_function(arg1, arg2=4):
    """
    Example function demonstrating Google-style docstrings.

    Args:
        arg1 (int): The first argument.
        arg2 (int): The second argument, with a default value of 4.

    Returns:
        (bool): True if successful, False otherwise.

    Examples:
        >>> result = example_function(1, 2)  # returns False
    """
    if arg1 == arg2:
        return True
    return False

def example_function(arg1: int, arg2: int = 4) -> bool:
    """
    Example function demonstrating Google-style docstrings.

    Args:
        arg1: The first argument.
        arg2: The second argument, with a default value of 4.

    Returns:
        True if successful, False otherwise.

    Examples:
        >>> result = example_function(1, 2)  # returns False
    """
    if arg1 == arg2:
        return True
    return False

def example_small_function(arg1: int, arg2: int = 4) -> bool:
    """Example function with a single-line docstring."""
    return arg1 == arg2

GitHub 액션 CI 테스트

모든 풀 리퀘스트는 병합되기 전에 GitHub Actions 지속적 통합 (CI) 테스트를 통과해야 합니다. 이러한 테스트에는 변경 사항이 프로젝트의 품질 표준을 충족하는지 확인하기 위한 린팅, 단위 테스트 및 기타 검사가 포함됩니다. CI 결과를 검토하고 발생하는 모든 문제를 해결하세요.

버그 신고하기

버그 신고는 프로젝트의 품질을 유지하는 데 큰 도움이 되므로 매우 소중하게 생각합니다. 버그를 신고할 때는 문제를 일관되게 재현할 수 있는 간단하고 명확한 코드 예제인 최소 재현 가능한 예제를제공해 주세요. 이를 통해 문제를 신속하게 파악하고 해결할 수 있습니다.

라이선스

Ultralytics 는 리포지토리에 GNU Affero 일반 공중 라이선스 v3.0(AGPL-3.0 )을 사용합니다. 이 라이선스는 소프트웨어 개발의 개방성, 투명성, 협업적 개선을 촉진합니다. 모든 사용자가 소프트웨어를 자유롭게 사용, 수정, 공유할 수 있도록 보장하여 강력한 협업과 혁신의 커뮤니티를 조성합니다.

모든 기여자는 Ultralytics 오픈소스 커뮤니티에 효과적이고 윤리적으로 기여하기 위해 AGPL-3.0 라이선스 약관을 숙지할 것을 권장합니다.

YOLO 및 AGPL-3.0 규정 준수를 통한 프로젝트 오픈소스화

YOLO 모델을 사용하여 자체 프로젝트를 개발 및 출시하려는 경우, GNU Affero 일반 공중 라이선스 v3.0(AGPL-3.0 )에 따라 모든 파생 저작물이 공개 및 접근 가능한 상태로 유지됩니다. 이 섹션에서는 AGPL-3.0 을 준수하면서 프로젝트를 오픈소스화하는 데 도움이 되는 단계, 모범 사례 및 요구 사항을 포함한 지침을 제공합니다.

프로젝트 시작 옵션

이러한 접근 방식 중 하나를 사용하여 프로젝트를 시작할 수 있습니다:

1. Ultralytics YOLO 리포지토리 포크
   공식 Ultralytics YOLO 리포지토리를 https://github.com/ultralytics/ ultralytics 에서 직접 포크합니다.

   • 최신 YOLO 구현을 기반으로 직접 빌드하려는 경우 이 옵션을 사용합니다.
   • AGPL-3.0 을 준수하면서 필요에 따라 포크된 코드를 수정합니다.

2. Ultralytics 템플릿 리포지토리에서 시작
   https://github.com/ ultralytics/template에서 제공되는 Ultralytics 템플릿 리포지토리를 사용하세요.

   • 미리 구성된 모범 사례로 깔끔한 모듈식 프로젝트를 시작하는 데 이상적입니다.
   • 이 옵션은 YOLO 모델을 통합하거나 확장하는 프로젝트에 가벼운 시작점을 제공합니다.

오픈소스에 필요한 것

AGPL-3.0 을 준수하려면 프로젝트의 다음 구성 요소를 공개적으로 사용 가능하게 만들어야 합니다:

1. 전체 프로젝트 소스 코드:

   • YOLO 모델, 스크립트 및 유틸리티가 포함된 더 큰 프로젝트의 모든 코드를 포함하세요.

2. 모델 가중치 (수정된 경우):

   • 오픈 소스 프로젝트의 일부로 미세 조정되거나 수정된 모델 가중치를 공유하세요.

3. 구성 파일:

   • 다음과 같은 구성 파일을 제공하세요. .yaml 또는 .json 트레이닝 설정, 하이퍼파라미터 또는 배포 구성을 정의합니다.

4. 학습 데이터(재배포 가능한 경우):

   • 재배포가 가능한 전처리 또는 생성된 데이터를 포함할 경우, 리포지토리의 일부이거나 명확하게 링크되어 있는지 확인하세요.

5. 웹 애플리케이션 구성 요소:

   • 프로젝트가 웹 애플리케이션인 경우 모든 백엔드 및 프론트엔드 소스 코드, 특히 서버 측 컴포넌트를 포함하세요.

6. 문서화:

   • 프로젝트 사용, 빌드 및 확장 방법에 대한 명확한 설명서를 포함하세요.

7. 빌드 및 배포 스크립트:

   • 환경 설정, 애플리케이션 빌드 및 배포를 위한 다음과 같은 스크립트를 공유하세요. Dockerfiles, requirements.txt또는 Makefiles.

8. 테스트 프레임워크:

   • 단위 및 통합 테스트와 같은 테스트 케이스를 오픈소스화하여 재현성과 안정성을 보장하세요.

9. 타사 수정:

   • 수정한 타사 라이브러리의 소스 코드를 제공하세요.

프로젝트 오픈소스화 단계

1. 시작 지점을 선택하세요:

   • Ultralytics YOLO 리포지토리를 포크하거나 Ultralytics 템플릿 리포지토리에서 시작하세요.

2. 라이선스 설정:

   • 추가 LICENSE AGPL-3.0 텍스트가 포함된 파일입니다.

3. 크레딧 업스트림 기여:

   • README에 Ultralytics YOLO 에 대한 저작자 표시를 포함하세요. 예를 들어

     This project builds on [Ultralytics YOLO](https://github.com/ultralytics/ultralytics), licensed under AGPL-3.0.
     

4. 코드를 공개하세요:

   • 전체 프로젝트(위에 나열된 구성 요소 포함)를 공개 GitHub 리포지토리에 푸시합니다.

5. 프로젝트를 문서화하세요:

   • 명확하게 작성 README.md 설정, 사용 및 기여에 대한 지침이 포함되어 있습니다.

6. 기여를 활성화합니다:

   • 이슈 트래커와 기여 가이드라인을 설정하여 협업을 촉진하세요.

이 단계를 따르고 필요한 모든 구성 요소를 포함하면 AGPL-3.0 을 준수하고 오픈 소스 커뮤니티에 의미 있는 기여를 할 수 있습니다. 앞으로도 컴퓨터 비전의 협업과 혁신을 함께 촉진해 나갑시다! 🚀

리포지토리 구조 예시

아래는 AGPL-3.0 프로젝트의 구조 예시입니다. 자세한 내용은 https://github.com/ultralytics /template를 참조하세요.

my-yolo-project/
│
├── LICENSE               # AGPL-3.0 license text
├── README.md             # Project overview and license information
├── src/                  # Source code for the project
│   ├── model.py          # YOLO-based model implementation
│   ├── utils.py          # Utility scripts
│   └── ...
├── pyproject.toml        # Python dependencies
├── tests/                # Unit and integration tests
├── .github/              # GitHub Actions for CI
│   └── workflows/
│       └── ci.yml        # Continuous integration configuration
└── docs/                 # Project documentation
    └── index.md

이 가이드를 따르면 프로젝트가 AGPL-3.0 을 준수하는 동시에 오픈소스 커뮤니티에 기여할 수 있습니다. 여러분의 준수는 YOLO 과 같은 프로젝트의 성공을 이끄는 협업, 투명성 및 접근성의 정신을 강화합니다.

결론

오픈소스 프로젝트에 관심을 가져주셔서 감사합니다. Ultralytics 오픈소스 YOLO 프로젝트에 기여해 주셔서 감사합니다. 여러분의 참여는 소프트웨어의 미래를 만들고 혁신과 협업의 활기찬 커뮤니티를 구축하는 데 필수적입니다. 코드를 개선하거나 버그를 보고하거나 새로운 기능을 제안하는 등 여러분의 기여는 매우 소중합니다.

여러분의 아이디어가 실현되는 것을 보게 되어 기쁘고, 물체 인식 기술을 발전시키기 위한 여러분의 노력에 감사드립니다. 여러분과 함께 이 흥미진진한 오픈소스 여정에서 계속 성장하고 혁신해 나갑시다. 행복한 코딩! 🚀🌟

자주 묻는 질문

Ultralytics YOLO 오픈소스 리포지토리에 기여해야 하는 이유는 무엇인가요?

Ultralytics YOLO 오픈 소스 리포지토리에 기여하면 소프트웨어가 개선되어 전체 커뮤니티를 위해 더욱 강력하고 풍부한 기능을 제공합니다. 기여에는 코드 개선, 버그 수정, 문서 개선 및 새로운 기능 구현이 포함될 수 있습니다. 또한, 기여를 통해 해당 분야의 다른 숙련된 개발자 및 전문가와 협업하여 자신의 기술과 평판을 높일 수 있습니다. 시작하는 방법에 대한 자세한 내용은 풀 리퀘스트를 통해 기여하기 섹션을 참조하세요.

Ultralytics YOLO 에 대한 기여자 라이선스 계약(CLA)에 어떻게 서명하나요?

기여자 라이선스 계약(CLA)에 서명하려면 풀 리퀘스트를 제출한 후 CLA 봇이 제공하는 지침을 따르세요. 이 프로세스를 통해 여러분의 기여가 AGPL-3.0 라이선스에 따라 적절하게 라이선스가 부여되어 오픈소스 프로젝트의 법적 무결성을 유지할 수 있습니다. 풀 리퀘스트에 다음과 같은 코멘트를 추가하세요:

I have read the CLA Document and I sign the CLA.

자세한 내용은 CLA 서명 섹션을 참조하세요.

Google-스타일 문서 문자열이란 무엇이며 Ultralytics YOLO 기여에 필요한 이유는 무엇인가요?

Google-스타일 독스트링은 함수와 클래스에 대한 명확하고 간결한 문서를 제공하여 코드 가독성과 유지보수성을 향상시킵니다. 이러한 독스트링은 함수의 목적, 인수, 반환값을 특정 서식 규칙과 함께 간략하게 설명합니다. Ultralytics YOLO 에 기여하실 때 Google-스타일의 문서 문자열을 따르면 추가한 내용이 잘 문서화되고 쉽게 이해될 수 있습니다. 예제와 가이드라인은 Google-스타일 독스트링 섹션을 참조하세요.

내 변경 사항이 GitHub Actions CI 테스트를 통과하려면 어떻게 해야 하나요?

풀 리퀘스트를 병합하려면 먼저 모든 GitHub Actions 지속적 통합(CI) 테스트를 통과해야 합니다. 이러한 테스트에는 린팅, 단위 테스트 및 코드가 다음을 충족하는지 확인하기 위한 기타 검사가 포함됩니다.

프로젝트의 품질 표준을 확인합니다. CI 결과물을 검토하고 문제를 수정합니다. CI 프로세스 및 문제 해결 팁에 대한 자세한 내용은 GitHub Actions CI 테스트 섹션을 참조하세요.

Ultralytics YOLO 리포지토리에서 버그를 신고하려면 어떻게 하나요?

버그를 신고하려면 버그 신고와 함께 명확하고 간결한 최소 재현 가능한 예시를 제공하세요. 이렇게 하면 개발자가 문제를 빠르게 파악하고 수정하는 데 도움이 됩니다. 최소한의 예제이지만 문제를 재현하기에 충분한지 확인하세요. 버그 신고에 대한 자세한 단계는 버그 신고하기 섹션을 참조하세요.

📅1 년 전 생성됨 ✏️ 10 일 전 업데이트됨

댓글