─░├žeri─če ge├ž

Ultralytics A├ž─▒k Kaynak YOLO Depolar─▒na Katk─▒da Bulunma

Thank you for your interest in contributing to Ultralytics open-source YOLO repositories! Your contributions will enhance the project and benefit the entire community. This document provides guidelines and best practices to help you get started.

─░├žindekiler

  1. Davran─▒┼č Kurallar─▒
  2. Çekme İstekleri ile Katkıda Bulunma
  3. Hatalar─▒n Raporlanmas─▒
  4. Lisans
  5. Sonu├ž

Davran─▒┼č Kurallar─▒

All contributors must adhere to the Code of Conduct to ensure a welcoming and inclusive environment for everyone.

Çekme İstekleri ile Katkıda Bulunma

We welcome contributions in the form of pull requests. To streamline the review process, please follow these guidelines:

  1. Fork the repository: Fork the Ultralytics YOLO repository to your GitHub account.

  2. Bir ┼čube olu┼čturun: ├çatallanm─▒┼č deponuzda de─či┼čiklikleriniz i├žin a├ž─▒klay─▒c─▒ bir adla yeni bir dal olu┼čturun.

  3. Make your changes: Ensure that your changes follow the project's coding style and do not introduce new errors or warnings.

  4. Test your changes: Test your changes locally to ensure they work as expected and do not introduce new issues.

  5. Commit your changes: Commit your changes with a descriptive commit message. Include any relevant issue numbers in your commit message.

  6. Create a pull request: Create a pull request from your forked repository to the main Ultralytics YOLO repository. Provide a clear explanation of your changes and how they improve the project.

CLA ─░mzalama

Before we can accept your pull request, you must sign a Contributor License Agreement (CLA). This legal document ensures that your contributions are properly licensed and that the project can continue to be distributed under the AGPL-3.0 license.

CLA'y─▒ imzalamak i├žin, PR'nizi g├Ânderdikten sonra CLA botu taraf─▒ndan sa─članan talimatlar─▒ izleyin ve PR'nize ┼č├Âyle bir yorum ekleyin:

I have read the CLA Document and I sign the CLA

Google Tarz─▒ Dok├╝man Dizileri

When adding new functions or classes, include a Google-style docstring to provide clear and concise documentation for other developers. This helps ensure your contributions are easy to understand and maintain.

├ľrnek Dok├╝man Dizeleri

Bu ├Ârnekte Google tarz─▒ bir docstring g├Âsterilmektedir. Hem girdi hem de ├ž─▒kt─▒n─▒n types must always be enclosed by parentheses, i.e., (bool).

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

This example shows both a Google-style docstring and argument and return type hints, though both are not required; one can be used without the other.

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

Smaller or simpler functions can utilize a single-line docstring. Note the docstring must use 3 double-quotes and be a complete sentence starting with a capital letter and ending with a period.

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

GitHub Eylemleri CI Testleri

Before your pull request can be merged, all GitHub Actions Continuous Integration (CI) tests must pass. These tests include linting, unit tests, and other checks to ensure your changes meet the project's quality standards. Review the output of the GitHub Actions and fix any issues.

Hatalar─▒n Raporlanmas─▒

We appreciate bug reports as they play a crucial role in maintaining the project's quality. When reporting bugs, it is important to provide a Minimum Reproducible Example: a clear, concise code example that replicates the issue. This helps in quick identification and resolution of the bug.

Lisans

Ultralytics depolar─▒ i├žin GNU Affero Genel Kamu Lisans─▒ v3.0'─▒ (AGPL-3.0 ) benimser ve yaz─▒l─▒m geli┼čtirmede a├ž─▒kl─▒─č─▒, ┼čeffafl─▒─č─▒ ve i┼čbirli─čine dayal─▒ iyile┼čtirmeyi te┼čvik eder. Bu g├╝├žl├╝ copyleft lisans─▒, t├╝m kullan─▒c─▒lar─▒n ve geli┼čtiricilerin yaz─▒l─▒m─▒ kullanma, de─či┼čtirme ve payla┼čma ├Âzg├╝rl├╝─č├╝n├╝ korumas─▒n─▒ sa─člar. Herhangi bir iyile┼čtirmenin herkes taraf─▒ndan eri┼čilebilir kalmas─▒n─▒ sa─člayarak topluluk i┼čbirli─čini te┼čvik eder.

Kullan─▒c─▒lar─▒n ve geli┼čtiricilerin Ultralytics a├ž─▒k kaynak toplulu─čuna etkin ve etik bir ┼čekilde katk─▒da bulunabilmeleri i├žin AGPL-3.0 ┼čartlar─▒n─▒ ├Â─črenmeleri te┼čvik edilmektedir.

Sonu├ž

Ultralytics a├ž─▒k kaynakl─▒ YOLO projelerine katk─▒da bulunmaya g├Âsterdi─činiz ilgi i├žin te┼čekk├╝r ederiz. Kat─▒l─▒m─▒n─▒z, yaz─▒l─▒m─▒m─▒z─▒n gelece─čini ┼čekillendirmek ve bir yenilik ve i┼čbirli─či toplulu─čunu te┼čvik etmek i├žin ├žok ├Ânemlidir. ─░ster kodu geli┼čtiriyor, ister hatalar─▒ bildiriyor veya ├Âzellikler ├Âneriyor olun, katk─▒lar─▒n─▒z ├Ânemli bir etki yarat─▒r.

We look forward to seeing your ideas in action and appreciate your commitment to advancing object detection technology. Let's continue to grow and innovate together in this exciting open-source journey. Happy coding! ­čÜÇ­čîč



Created 2023-11-12, Updated 2024-06-08
Authors: UltralyticsAssistant (1), glenn-jocher (7)

Yorumlar