diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index f23678b0..09489919 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -74,7 +74,7 @@ body: attributes: label: Minimal Reproducible Example description: > - When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimal reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/). + When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimal reproducible example](https://docs.ultralytics.com/help/minimum-reproducible-example/). placeholder: | ``` # Code to reproduce your issue here diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index aee55396..38375c7f 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -32,7 +32,7 @@ jobs: first_issue_response: | πŸ‘‹ Hello @${{ github.actor }}, thank you for your interest in Ultralytics πŸš€! We recommend a visit to the [Docs](https://docs.ultralytics.com) for new users where you can find many [Python](https://docs.ultralytics.com/usage/python/) and [CLI](https://docs.ultralytics.com/usage/cli/) usage examples and where many of the most common questions may already be answered. - If this is a πŸ› Bug Report, please provide a [minimum reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/) to help us debug it. + If this is a πŸ› Bug Report, please provide a [minimum reproducible example](https://docs.ultralytics.com/help/minimum-reproducible-example/) to help us debug it. If this is a custom training ❓ Question, please provide as much information as possible, including dataset image examples and training logs, and verify you are following our [Tips for Best Training Results](https://docs.ultralytics.com/guides/model-training-tips/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3dbfe16..15447bce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ Welcome! We're thrilled that you're considering contributing to our [Ultralytics ## Code of Conduct -To ensure a welcoming and inclusive environment for everyone, all contributors must adhere to our [Code of Conduct](https://docs.ultralytics.com/help/code_of_conduct/). Respect, kindness, and professionalism are at the heart of our community. +To ensure a welcoming and inclusive environment for everyone, all contributors must adhere to our [Code of Conduct](https://docs.ultralytics.com/help/code-of-conduct/). Respect, kindness, and professionalism are at the heart of our community. ## Contributing via Pull Requests @@ -121,7 +121,7 @@ All pull requests must pass the GitHub Actions [Continuous Integration](https:// ## Reporting Bugs -We highly value bug reports as they help us maintain the quality of our projects. When reporting a bug, please provide a [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum_reproducible_example/)β€”a simple, clear code example that consistently reproduces the issue. This allows us to quickly identify and resolve the problem. +We highly value bug reports as they help us maintain the quality of our projects. When reporting a bug, please provide a [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum-reproducible-example/)β€”a simple, clear code example that consistently reproduces the issue. This allows us to quickly identify and resolve the problem. ## License @@ -163,4 +163,4 @@ the project's quality standards. Review the CI output and fix any issues. For de ### How do I report a bug in Ultralytics YOLO repositories? -To report a bug, provide a clear and concise [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum_reproducible_example/) along with your bug report. This helps developers quickly identify and fix the issue. Ensure your example is minimal yet sufficient to replicate the problem. For more detailed steps on reporting bugs, refer to the [Reporting Bugs](#reporting-bugs) section. +To report a bug, provide a clear and concise [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum-reproducible-example/) along with your bug report. This helps developers quickly identify and fix the issue. Ensure your example is minimal yet sufficient to replicate the problem. For more detailed steps on reporting bugs, refer to the [Reporting Bugs](#reporting-bugs) section. diff --git a/docs/en/help/code_of_conduct.md b/docs/en/help/code-of-conduct.md similarity index 100% rename from docs/en/help/code_of_conduct.md rename to docs/en/help/code-of-conduct.md diff --git a/docs/en/help/contributing.md b/docs/en/help/contributing.md index c637c593..4e84799e 100644 --- a/docs/en/help/contributing.md +++ b/docs/en/help/contributing.md @@ -13,7 +13,7 @@ Welcome! We're thrilled that you're considering contributing to our [Ultralytics ## Code of Conduct -To ensure a welcoming and inclusive environment for everyone, all contributors must adhere to our [Code of Conduct](https://docs.ultralytics.com/help/code_of_conduct/). Respect, kindness, and professionalism are at the heart of our community. +To ensure a welcoming and inclusive environment for everyone, all contributors must adhere to our [Code of Conduct](https://docs.ultralytics.com/help/code-of-conduct/). Respect, kindness, and professionalism are at the heart of our community. ## Contributing via Pull Requests @@ -111,7 +111,7 @@ All pull requests must pass the GitHub Actions [Continuous Integration](https:// ## Reporting Bugs -We highly value bug reports as they help us maintain the quality of our projects. When reporting a bug, please provide a [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum_reproducible_example/)β€”a simple, clear code example that consistently reproduces the issue. This allows us to quickly identify and resolve the problem. +We highly value bug reports as they help us maintain the quality of our projects. When reporting a bug, please provide a [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum-reproducible-example/)β€”a simple, clear code example that consistently reproduces the issue. This allows us to quickly identify and resolve the problem. ## License @@ -265,4 +265,4 @@ the project's quality standards. Review the CI output and fix any issues. For de ### How do I report a bug in Ultralytics YOLO repositories? -To report a bug, provide a clear and concise [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum_reproducible_example/) along with your bug report. This helps developers quickly identify and fix the issue. Ensure your example is minimal yet sufficient to replicate the problem. For more detailed steps on reporting bugs, refer to the [Reporting Bugs](#reporting-bugs) section. +To report a bug, provide a clear and concise [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum-reproducible-example/) along with your bug report. This helps developers quickly identify and fix the issue. Ensure your example is minimal yet sufficient to replicate the problem. For more detailed steps on reporting bugs, refer to the [Reporting Bugs](#reporting-bugs) section. diff --git a/docs/en/help/index.md b/docs/en/help/index.md index c1ff0128..cc9b6c60 100644 --- a/docs/en/help/index.md +++ b/docs/en/help/index.md @@ -10,8 +10,8 @@ Welcome to the Ultralytics Help page! We are dedicated to providing you with det - [Contributing Guide](contributing.md): Discover the protocols for making contributions, including how to submit pull requests, report bugs, and more. - [Continuous Integration (CI) Guide](CI.md): Gain insights into the CI processes we employ, complete with status reports for each Ultralytics repository. - [Contributor License Agreement (CLA)](CLA.md): Review the CLA to understand the rights and responsibilities associated with contributing to Ultralytics projects. -- [Minimum Reproducible Example (MRE) Guide](minimum_reproducible_example.md): Learn the process for creating an MRE, which is crucial for the timely and effective resolution of bug reports. -- [Code of Conduct](code_of_conduct.md): Our community guidelines support a respectful and open atmosphere for all collaborators. +- [Minimum Reproducible Example (MRE) Guide](minimum-reproducible-example.md): Learn the process for creating an MRE, which is crucial for the timely and effective resolution of bug reports. +- [Code of Conduct](code-of-conduct.md): Our community guidelines support a respectful and open atmosphere for all collaborators. - [Environmental, Health and Safety (EHS) Policy](environmental-health-safety.md): Delve into our commitment to sustainability and the well-being of all our stakeholders. - [Security Policy](security.md): Familiarize yourself with our security protocols and the procedure for reporting vulnerabilities. - [Privacy Policy](privacy.md): Read our privacy policy to understand how we protect your data and respect your privacy in all our services and operations. @@ -28,7 +28,7 @@ For more details on YOLO11, visit the [YOLO11 documentation](../tasks/detect.md) ### How do I contribute to Ultralytics YOLO repositories? -Contributing to Ultralytics YOLO repositories is straightforward. Start by reviewing the [Contributing Guide](../help/contributing.md) to understand the protocols for submitting pull requests, reporting bugs, and more. You'll also need to sign the [Contributor License Agreement (CLA)](../help/CLA.md) to ensure your contributions are legally recognized. For effective bug reporting, refer to the [Minimum Reproducible Example (MRE) Guide](../help/minimum_reproducible_example.md). +Contributing to Ultralytics YOLO repositories is straightforward. Start by reviewing the [Contributing Guide](../help/contributing.md) to understand the protocols for submitting pull requests, reporting bugs, and more. You'll also need to sign the [Contributor License Agreement (CLA)](../help/CLA.md) to ensure your contributions are legally recognized. For effective bug reporting, refer to the [Minimum Reproducible Example (MRE) Guide](../help/minimum-reproducible-example.md). ### Why should I use Ultralytics HUB for my machine learning projects? diff --git a/docs/en/help/minimum_reproducible_example.md b/docs/en/help/minimum-reproducible-example.md similarity index 100% rename from docs/en/help/minimum_reproducible_example.md rename to docs/en/help/minimum-reproducible-example.md diff --git a/docs/en/hub/index.md b/docs/en/hub/index.md index 7dc27433..d48485de 100644 --- a/docs/en/hub/index.md +++ b/docs/en/hub/index.md @@ -7,7 +7,7 @@ keywords: Ultralytics HUB, YOLO models, train YOLO, YOLOv5, YOLOv8, object detec # Ultralytics HUB
- +Ultralytics HUB banner δΈ­ζ–‡ | ν•œκ΅­μ–΄ | ζ—₯本θͺž | diff --git a/mkdocs.yml b/mkdocs.yml index 8784a91f..1ac53c83 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -624,8 +624,8 @@ nav: - Contributing Guide: help/contributing.md - Continuous Integration (CI) Guide: help/CI.md - Contributor License Agreement (CLA): help/CLA.md - - Minimum Reproducible Example (MRE) Guide: help/minimum_reproducible_example.md - - Code of Conduct: help/code_of_conduct.md + - Minimum Reproducible Example (MRE) Guide: help/minimum-reproducible-example.md + - Code of Conduct: help/code-of-conduct.md - Environmental, Health and Safety (EHS) Policy: help/environmental-health-safety.md - Security Policy: help/security.md - Privacy Policy: help/privacy.md @@ -699,6 +699,8 @@ plugins: tasks/keypoints.md: tasks/pose.md tasks/tracking.md: modes/track.md SECURITY.md: help/security.md + help/minimum_reproducible_example.md: help/minimum-reproducible-example.md + help/code_of_conduct.md: help/code-of-conduct.md tutorials/architecture-summary.md: yolov5/tutorials/architecture_description.md tutorials/clearml-logging.md: yolov5/tutorials/clearml_logging_integration.md tutorials/comet-logging.md: yolov5/tutorials/comet_logging_integration.md