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

환영합니다! 기여를 고려하고 계신다니 기쁘게 생각합니다. Ultralytics 오픈 소스 프로젝트에 기여해 주셔서 감사합니다. 여러분의 참여는 저장소의 품질을 향상시키는 데 도움이 될 뿐만 아니라 전체 컴퓨터 비전 커뮤니티에도 도움이 됩니다. 이 가이드는 시작하는 데 도움이 되는 명확한 지침과 모범 사례를 제공합니다.

Watch: Ultralytics 리포지토리에 기여하는 방법 | Ultralytics 모델, 데이터 세트 및 설명서 🚀

🤝 행동 강령

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

🚀 풀 리퀘스트를 통해 기여하기

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

리포지토리를 포크합니다: 먼저 관련 Ultralytics 리포지토리(예: ultralyticsultralyticsultralytics)를 GitHub 계정으로 포크하세요.
지점을 만듭니다: 포크된 리포지토리에 변경 사항을 반영하는 명확하고 설명이 포함된 이름을 사용하여 새 브랜치를 만듭니다(예, fix-issue-123, add-feature-xyz).
변경 사항을 적용합니다: 개선 사항이나 수정 사항을 구현합니다. 코드가 프로젝트의 스타일 가이드라인을 준수하고 새로운 오류나 경고를 유발하지 않는지 확인하세요.
변경 사항을 테스트합니다: 제출하기 전에 로컬에서 변경 사항을 테스트하여 예상대로 작동하는지, 회귀 현상이 발생하지 않는지 확인하세요. 새로운 기능을 도입하는 경우 테스트를 추가하세요.
변경 사항을 커밋합니다: 간결하고 설명적인 커밋 메시지로 변경 내용을 커밋하세요. 변경 사항이 특정 이슈를 다루는 경우 이슈 번호(예, Fix #123: Corrected calculation error.).
풀 리퀘스트를 만듭니다: 지사에서 풀 리퀘스트를 제출하여 main 브랜치에 저장하세요. 변경의 목적과 범위를 설명하는 명확한 제목과 자세한 설명을 제공하세요.

📝 CLA 서명

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

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

I have read the CLA Document and I sign the CLA

✍️ Google 문서 스트링

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

문서 문자열 예제

Google-스타일Google-유형 힌트가 있는 스타일단일 라인

이 예는 Google-스타일의 문서 문자열을 보여줍니다. 입력과 출력 모두 types 는 항상 괄호로 묶습니다(예:, (bool).

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

이 예제에는 인수 및 반환에 대한 Google 문서 문자열과 유형 힌트가 모두 포함되어 있지만, 둘 중 하나를 독립적으로 사용하는 것도 허용됩니다.

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 프로젝트에 코드를 기여할 때는 다음 모범 사례를 염두에 두세요:

코드 중복을 피하세요: 가능하면 기존 코드를 재사용하고 불필요한 인수를 최소화하세요.
작고 집중적으로 변경하세요: 대규모 변경보다는 대상에 맞는 수정에 집중하세요.
가능하면 단순화하세요: 코드를 단순화하거나 불필요한 부분을 제거할 수 있는 기회를 찾아보세요.
호환성을 고려하세요: 변경하기 전에 변경 사항이 Ultralytics 사용하는 기존 코드를 손상시킬 수 있는지 고려하세요.
일관된 서식을 사용하세요: 러프 포맷터와 같은 도구는 문체의 일관성을 유지하는 데 도움이 됩니다.
적절한 테스트를 추가합니다: 새로운 기능이 예상대로 작동하는지 확인하기 위해 테스트를 포함하세요.

👀 풀 리퀘스트 검토

풀 리퀘스트를 검토하는 것도 기여하는 또 다른 유용한 방법입니다. PR을 검토할 때:

단위 테스트를 확인합니다: PR에 새로운 기능이나 변경 사항에 대한 테스트가 포함되어 있는지 확인합니다.
문서 업데이트를 검토합니다: 변경 사항을 반영하여 문서가 업데이트되었는지 확인합니다.
성능에 미치는 영향을 평가합니다: 변경 사항이 성능에 어떤 영향을 미칠지 고려하세요.
CI 테스트를 확인합니다: 모든 지속적 통합 테스트가 통과되었는지 확인합니다.
건설적인 피드백을 제공하세요: 문제나 우려 사항에 대해 구체적이고 명확한 피드백을 제공하세요.
노력을 인정합니다: 긍정적인 협업 분위기를 유지하기 위해 작성자의 노력을 인정합니다.

🐞 버그 신고하기

버그 보고는 프로젝트의 품질과 안정성을 개선하는 데 큰 도움이 되므로 매우 소중하게 생각합니다. GitHub 이슈를 통해 버그를 보고하세요:

기존 문제를 확인합니다: 먼저 검색을 통해 해당 버그가 이미 보고되었는지 확인하세요.
재현 가능한 최소한의 예제를 제공하세요: 문제를 일관되게 재현하는 작은 독립된 코드 스니펫을 만드세요. 이는 효율적인 디버깅을 위해 매우 중요합니다.
환경을 설명합니다: 운영 체제, Python 버전, 관련 라이브러리 버전(예, torch, ultralytics), 하드웨어(CPU/GPU).
예상했던 행동과 실제 행동을 설명합니다: 예상한 것과 실제로 발생한 것을 명확하게 설명하세요. 오류 메시지나 트레이스백을 포함하세요.

📜 라이선스

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

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

🌍 AGPL-3.0 따른 YOLO 프로젝트 오픈소스화

프로젝트에서 Ultralytics YOLO 모델이나 코드를 사용하시나요? AGPL-3.0 . AGPL-3.0 라이선스는 전체 파생 작업도 AGPL-3.0 따라 오픈 소스화할 것을 요구합니다. 이렇게 하면 오픈 소스 기반에 구축된 수정 사항과 대규모 프로젝트가 계속 공개됩니다.

AGPL-3.0 규정 준수가 중요한 이유

소프트웨어를 개방적으로 유지합니다: 개선 사항과 파생 저작물이 커뮤니티에 도움이 되도록 합니다.
법적 요구 사항: AGPL-3.0 라이선스 코드를 사용하면 프로젝트가 해당 약관에 구속됩니다.
협업을 촉진합니다: 공유와 투명성을 장려합니다.

프로젝트를 오픈소스화하지 않으려면 엔터프라이즈 라이선스를 취득하는 것이 좋습니다.

AGPL-3.0 준수 방법

준수한다는 것은 프로젝트의 해당 소스 코드 전체를 AGPL-3.0 라이선스에 따라 공개하는 것을 의미합니다.

시작 지점을 선택하세요:
- Ultralytics YOLO 포크: Ultralytics YOLO 리포지토리를 기반으로 긴밀하게 구축하는 경우 직접 포크하세요.
- Ultralytics 템플릿 사용: YOLO 통합하는 깔끔한 모듈식 설정을 위해 Ultralytics 템플릿 리포지토리로 시작하세요.
프로젝트 라이선스:
- 추가 LICENSE 파일의 전체 텍스트가 포함된 AGPL-3.0 라이선스.
- 각 소스 파일 상단에 라이선스를 나타내는 알림을 추가합니다.
소스 코드를 게시합니다:
- 당신의 전체 프로젝트의 소스 코드 공개적으로 액세스할 수 있는 곳(예: GitHub)에 있습니다. 여기에는 다음이 포함됩니다:
  - YOLO 모델 또는 코드를 통합하는 완전한 대규모 애플리케이션 또는 시스템입니다.
  - 원래의 Ultralytics YOLO 코드에 대한 모든 수정 사항.
  - 교육, 검증, 추론용 스크립트.
  - 모델 가중치를 수정하거나 미세 조정한 경우.
  - 구성 파일환경 설정(requirements.txt, Dockerfiles).
  - 웹 애플리케이션의 일부인 경우 백엔드 및 프론트엔드 코드.
  - 수정한 모든 타사 라이브러리.
  - 실행/재훈련에 필요하고 재배포가 가능한 트레이닝 데이터.
명확하게 문서화하세요:
- 업데이트 README.md 를 추가하여 프로젝트가 AGPL-3.0 따라 라이선스가 부여되었음을 명시합니다.
- 소스 코드에서 프로젝트를 설정, 빌드 및 실행하는 방법에 대한 명확한 지침을 포함하세요.
- Ultralytics YOLO 적절하게 어트리뷰션하여 다시 원본 리포지토리. 예제:
```
This project utilizes code from [Ultralytics YOLO](https://github.com/ultralytics/ultralytics), licensed under AGPL-3.0.
```

리포지토리 구조 예시

실제 예제 구조는 Ultralytics 템플릿 리포지토리를 참조하세요:

my-yolo-project/
│
├── LICENSE               # Full AGPL-3.0 license text
├── README.md             # Project description, setup, usage, license info & attribution
├── pyproject.toml        # Dependencies (or requirements.txt)
├── scripts/              # Training/inference scripts
│   └── train.py
├── src/                  # Your project's source code
│   ├── __init__.py
│   ├── data_loader.py
│   └── model_wrapper.py  # Code interacting with YOLO
├── tests/                # Unit/integration tests
├── configs/              # YAML/JSON config files
├── docker/               # Dockerfiles, if used
│   └── Dockerfile
└── .github/              # GitHub specific files (e.g., workflows for CI)
    └── workflows/
        └── ci.yml

이 가이드라인을 준수하면 AGPL-3.0 준수하여 Ultralytics 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 리포지토리에서 버그를 신고하려면 어떻게 하나요?

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

내 프로젝트에서 AGPL-3.0 라이선스를 사용하는 경우, 내 프로젝트에 Ultralytics YOLO 사용하려면 어떻게 해야 하나요?

프로젝트에서 AGPL-3.0 따라 라이선스가 부여된 Ultralytics YOLO 코드 또는 모델을 사용하는 경우, AGPL-3.0 . AGPL-3.0 라이선스는 전체 프로젝트(파생 저작물)도 AGPL-3.0 따라 라이선스가 부여되어야 하며 전체 소스 코드를 공개적으로 사용할 수 있어야 한다는 것을 요구합니다. 이를 통해 소프트웨어의 오픈 소스 특성이 파생 저작물 전체에 걸쳐 유지됩니다. 이러한 요구 사항을 충족할 수 없는 경우 엔터프라이즈 라이선스를 취득해야 합니다. 자세한 내용은 프로젝트 오픈소스화하기 섹션을 참조하세요.

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