From 91218583d35d01710b3d60ec187ad5b0fca22fc1 Mon Sep 17 00:00:00 2001 From: Francesco Mattioli Date: Tue, 30 Jul 2024 00:01:31 +0200 Subject: [PATCH] Update Ultralytics issue templates (#14718) Co-authored-by: UltralyticsAssistant Co-authored-by: Burhan <62214284+Burhan-Q@users.noreply.github.com> Co-authored-by: Glenn Jocher --- .github/ISSUE_TEMPLATE/bug-report.yml | 27 +++++++++++++-------------- .github/ISSUE_TEMPLATE/question.yml | 10 +++++----- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 482bd551..430b0595 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -2,13 +2,13 @@ name: 🐛 Bug Report # title: " " -description: Problems with YOLOv8 +description: Problems with Ultralytics YOLO labels: [bug, triage] body: - type: markdown attributes: value: | - Thank you for submitting a YOLOv8 🐛 Bug Report! + Thank you for submitting an Ultralytics YOLO 🐛 Bug Report! - type: checkboxes attributes: @@ -17,14 +17,14 @@ body: Please search the Ultralytics [Docs](https://docs.ultralytics.com) and [issues](https://github.com/ultralytics/ultralytics/issues) to see if a similar bug report already exists. options: - label: > - I have searched the YOLOv8 [issues](https://github.com/ultralytics/ultralytics/issues) and found no similar bug report. + I have searched the Ultralytics YOLO [issues](https://github.com/ultralytics/ultralytics/issues) and found no similar bug report. required: true - type: dropdown attributes: - label: YOLOv8 Component + label: Ultralytics YOLO Component description: | - Please select the part of YOLOv8 where you found the bug. + Please select the Ultralytics YOLO component where you found the bug. multiple: true options: - "Install" @@ -43,16 +43,16 @@ body: - type: textarea attributes: label: Bug - description: Provide console output with error messages and/or screenshots of the bug. + description: Please provide as much information as possible. Copy and paste console output and error messages. Use [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format text, code and logs. If necessary, include screenshots for visual elements only. Providing detailed information will help us resolve the issue more efficiently. placeholder: | - 💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response. + 💡 ProTip! Include as much information as possible (logs, tracebacks, screenshots, etc.) to receive the most helpful response. validations: required: true - type: textarea attributes: label: Environment - description: Please specify the software and hardware you used to produce the bug. + description: Many issues are often related to dependency versions and hardware. Please provide the output of `yolo checks` or `ultralytics.checks()` command to help us diagnose the problem. placeholder: | Paste output of `yolo checks` or `ultralytics.checks()` command, i.e.: ``` @@ -68,20 +68,19 @@ body: CUDA None ``` validations: - required: false + required: true - type: textarea 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 ``` validations: - required: false + required: true - type: textarea attributes: @@ -92,7 +91,7 @@ body: attributes: label: Are you willing to submit a PR? description: > - (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/ultralytics/pulls) (PR) to help improve YOLOv8 for everyone, especially if you have a good understanding of how to implement a fix or feature. - See the YOLOv8 [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. + (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/ultralytics/pulls) (PR) to help improve Ultralytics YOLO for everyone, especially if you have a good understanding of how to implement a fix or feature. + See the Ultralytics YOLO [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. options: - label: Yes I'd like to help by submitting a PR! diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 45e55010..f957b43d 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,14 +1,14 @@ # Ultralytics YOLO 🚀, AGPL-3.0 license name: ❓ Question -description: Ask a YOLOv8 question +description: Ask an Ultralytics YOLO question # title: " " labels: [question] body: - type: markdown attributes: value: | - Thank you for asking a YOLOv8 ❓ Question! + Thank you for asking an Ultralytics YOLO ❓ Question! - type: checkboxes attributes: @@ -17,15 +17,15 @@ body: Please search the Ultralytics [Docs](https://docs.ultralytics.com), [issues](https://github.com/ultralytics/ultralytics/issues) and [discussions](https://github.com/ultralytics/ultralytics/discussions) to see if a similar question already exists. options: - label: > - I have searched the YOLOv8 [issues](https://github.com/ultralytics/ultralytics/issues) and [discussions](https://github.com/ultralytics/ultralytics/discussions) and found no similar questions. + I have searched the Ultralytics YOLO [issues](https://github.com/ultralytics/ultralytics/issues) and [discussions](https://github.com/ultralytics/ultralytics/discussions) and found no similar questions. required: true - type: textarea attributes: label: Question - description: What is your question? + description: What is your question? Please provide as much information as possible. Include detailed code examples to reproduce the problem and describe the context in which the issue occurs. Format your text and code using [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for clarity and readability. Following these guidelines will help us assist you more effectively. placeholder: | - 💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response. + 💡 ProTip! Include as much information as possible (logs, tracebacks, screenshots etc.) to receive the most helpful response. validations: required: true