From 5695b7f58f9dd2f8d5e2995ed5147971a3778dab Mon Sep 17 00:00:00 2001 From: Jirka Borovec <6035284+Borda@users.noreply.github.com> Date: Mon, 12 Jan 2026 13:32:14 +0100 Subject: [PATCH] chore: Update issue templates for bug reports and feature requests (#2052) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: Update issue templates for bug reports and feature requests * fix(pre_commit): 🎨 auto format pre-commit hooks --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.yml | 63 +++++++++++----------- .github/ISSUE_TEMPLATE/config.yml | 14 +++++ .github/ISSUE_TEMPLATE/feature-request.yml | 39 +++++++------- .github/ISSUE_TEMPLATE/question.yml | 33 ------------ 4 files changed, 67 insertions(+), 82 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 0dd1bbad..bb47504a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,65 +1,68 @@ name: 🐞 Bug Report -# title: " " -description: Problems with Supervision +title: "[Bug]: " +description: Report a bug or unexpected behavior in Supervision labels: [bug] body: - - type: markdown - attributes: - value: | - Thank you for submitting a Supervision 🐞 Bug Report! - - type: checkboxes attributes: label: Search before asking - description: > - Please search the [issues](https://github.com/roboflow/supervision/issues) to see if a similar bug report already exists. + description: Please search [issues](https://github.com/roboflow/supervision/issues) and [discussions](https://github.com/roboflow/supervision/discussions) first. options: - - label: > - I have searched the Supervision [issues](https://github.com/roboflow/supervision/issues) and found no similar bug report. + - label: I have searched the issues and discussions and found no similar bug report. required: true - type: textarea attributes: label: Bug - description: Provide console output with error messages and/or screenshots of the bug. + description: Describe the bug, what you expected, and what actually happened. placeholder: | - 💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response. + **What's the bug?** + Brief description... + + **Expected behavior:** + What should happen... + + **Actual behavior:** + What actually happens... + + **Error/Traceback (if any):** + ```python + # Paste error messages here + ``` validations: required: true - type: textarea attributes: label: Environment - description: Please specify the software and hardware you used to produce the bug. + description: Your setup details placeholder: | - - Supervision: 0.1.0 - - OS: Ubuntu 20.04 - - Python: 3.8.10 + - Supervision: 0.23.0 + - Python: 3.10.12 + - OS: Ubuntu 22.04 + value: | + - Supervision: + - Python: + - OS: 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://stackoverflow.com/help/minimal-reproducible-example). + description: Code to reproduce the bug ([guide](https://stackoverflow.com/help/minimal-reproducible-example)) placeholder: | - ``` - # Code to reproduce your issue here + ```python + import supervision as sv + + # Your code here ``` validations: required: false - - type: textarea - attributes: - label: Additional - description: Anything else you would like to share? - - type: checkboxes attributes: label: Are you willing to submit a PR? - description: > - (Optional) We encourage you to submit a [Pull Request](https://github.com/roboflow/supervision/pulls) (PR) to help improve Supervision for everyone, especially if you have a good understanding of how to implement a fix or feature. + description: (Optional) We encourage community contributions! options: - label: Yes I'd like to help by submitting a PR! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..6631c7bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: ❓ Ask a Question + url: https://github.com/roboflow/supervision/discussions/new?category=q-a + about: Ask questions about using Supervision in GitHub Discussions + - name: 📚 Documentation + url: https://supervision.roboflow.com/ + about: Check the official Supervision documentation for guides and API references + - name: 💬 GitHub Discussions + url: https://github.com/roboflow/supervision/discussions + about: Join community discussions, share ideas, and get help + - name: 🌟 Show and Tell + url: https://github.com/roboflow/supervision/discussions/categories/show-and-tell + about: Share your projects and creations built with Supervision diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 9b723da6..7161b46e 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,6 +1,6 @@ name: 🤩 Feature Request -description: Suggest a Supervision idea -# title: " " +title: "[Feature]: " +description: Suggest a new feature or improvement labels: [enhancement] body: - type: markdown @@ -11,39 +11,40 @@ body: - type: checkboxes attributes: label: Search before asking - description: > - Please search the [issues](https://github.com/roboflow/supervision/issues) to see if a similar feature request already exists. + description: Please search [issues](https://github.com/roboflow/supervision/issues) and [discussions](https://github.com/roboflow/supervision/discussions) first. options: - - label: > - I have searched the Supervision [issues](https://github.com/roboflow/supervision/issues) and found no similar feature requests. + - label: I have searched the issues and discussions and found no similar feature request. required: true - type: textarea attributes: - label: Description - description: A short description of your feature. + label: Feature Description + description: What feature would you like and why? placeholder: | - What new feature would you like to see in Supervision? + **What:** Describe the feature... + + **Why:** What problem does it solve? Who would benefit? + + **How (optional):** Any ideas on implementation? validations: required: true - type: textarea attributes: - label: Use case - description: | - Describe the use case of your feature request. It will help us understand and prioritize the feature request. + label: Example Usage + description: (Optional) Show how you'd like to use this feature placeholder: | - How would this feature be used, and who would use it? + ```python + import supervision as sv - - type: textarea - attributes: - label: Additional - description: Anything else you would like to share? + # Your example usage here + ``` + validations: + required: false - type: checkboxes attributes: label: Are you willing to submit a PR? - description: > - (Optional) We encourage you to submit a [Pull Request](https://github.com/roboflow/supervision/pulls) (PR) to help improve Supervision for everyone, especially if you have a good understanding of how to implement a fix or feature. + description: (Optional) We encourage community contributions! 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 deleted file mode 100644 index 9f9987e0..00000000 --- a/.github/ISSUE_TEMPLATE/question.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: ❓ Question -description: Ask a Supervision question -# title: " " -labels: [question] -body: - - type: markdown - attributes: - value: | - Thank you for asking a Supervision ❓ Question! - - - type: checkboxes - attributes: - label: Search before asking - description: > - Please search the [issues](https://github.com/roboflow/supervision/issues) to see if a similar feature request already exists. - options: - - label: > - I have searched the Supervision [issues](https://github.com/roboflow/supervision/issues) and found no similar feature requests. - required: true - - - type: textarea - attributes: - label: Question - description: What is your question? - placeholder: | - 💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response. - validations: - required: true - - - type: textarea - attributes: - label: Additional - description: Anything else you would like to share?