Ultralytics 오픈소스 YOLO 리포지토리에 기여하기

먼저, Ultralytics 오픈소스 YOLO 리포지토리에 관심을 가져주셔서 감사합니다! 여러분의 기여는 프로젝트를 개선하고 커뮤니티에 도움이 됩니다. 이 문서는 시작하는 데 도움이 되는 가이드라인과 모범 사례를 제공합니다.

목차

1. 행동 강령
2. 풀 리퀘스트를 통한 기여
   • CLA 서명
   • Google 스타일 문서 스트링
   • GitHub 액션 CI 테스트
3. 버그 신고하기
4. 라이선스
5. 결론

행동 강령

모든 기여자는 모두를 환영하고 포용하는 환경을 조성하기 위해 행동 강령을 준수해야 합니다.

풀 리퀘스트를 통한 기여

풀 리퀘스트 형태의 기여를 환영합니다. 보다 원활한 검토 프로세스를 위해 다음 가이드라인을 따르세요:

1. 리포지토리 포크: Ultralytics YOLO 리포지토리를 자신의 GitHub 계정으로 포크합니다.

2. 브랜치 만들기: 포크된 리포지토리에 변경 내용을 설명할 수 있는 이름을 사용하여 새 브랜치를 만듭니다.

3. 변경 사항을 적용하세요: 기여하고 싶은 내용을 변경합니다. 변경 사항이 프로젝트의 코딩 스타일을 따르고 새로운 오류나 경고를 유발하지 않는지 확인합니다.

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

5. 변경 사항 커밋: 설명이 포함된 커밋 메시지로 변경 내용을 커밋합니다. 커밋 메시지에 관련 이슈 번호를 반드시 포함하세요.

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

CLA 서명

풀 리퀘스트를 수락하려면 먼저 기여자 라이선스 계약(CLA)에 서명해야 합니다. 이는 Ultralytics YOLO 리포지토리에 기여하는 조건에 동의한다는 것을 명시하는 법적 문서입니다. CLA는 여러분의 기여에 적절한 라이선스가 부여되고 프로젝트가 AGPL-3.0 라이선스에 따라 계속 배포될 수 있도록 보장합니다.

CLA에 서명하려면 PR을 제출한 후 CLA 봇이 제공하는 지침에 따라 PR에 다음과 같은 내용을 댓글로 추가하세요:

I have read the CLA Document and I sign the CLA

Google 스타일 문서 스트링

새로운 함수나 클래스를 추가할 때는 다른 개발자를 위해 명확하고 간결한 문서를 제공할 수 있도록 Google 스타일의 문서 스트링을 포함하세요. 이렇게 하면 여러분의 기여를 쉽게 이해하고 유지 관리할 수 있습니다.

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

    Args:
        arg1 (int): The first argument.
        arg2 (int): The second argument. Default value is 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 that demonstrates Google-style docstrings.

    Args:
        arg1: The first argument.
        arg2: The second argument. Default value is 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 that demonstrates a single-line docstring."""
    return arg1 == arg2

GitHub 액션 CI 테스트

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

버그 신고하기

버그 신고는 프로젝트의 품질을 유지하는 데 중요한 역할을 하므로 언제나 감사하게 생각합니다. 버그를 신고할 때는 문제를 재현할 수 있는 명확하고 간결한 코드 예제인 최소 재현 가능한 예제를 제공하는 것이 중요합니다. 이렇게 하면 버그를 빠르게 식별하고 해결하는 데 도움이 됩니다.

라이선스

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

사용자와 개발자는 Ultralytics 오픈소스 커뮤니티에 효과적이고 윤리적으로 기여하기 위해 AGPL-3.0 약관을 숙지하는 것이 좋습니다.

결론

Ultralytics 오픈소스 YOLO 프로젝트에 관심을 가져주셔서 감사합니다. 여러분의 참여는 소프트웨어의 미래를 만들고 혁신과 협업의 커뮤니티를 조성하는 데 매우 중요합니다. 코드를 개선하든, 버그를 보고하든, 기능을 제안하든, 여러분의 기여는 큰 영향을 미칩니다.

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

댓글