From 44675559e6aceb179b7d196da8d0a7ccce9000c5 Mon Sep 17 00:00:00 2001 From: Aniruddha Date: Sat, 21 Feb 2026 23:31:26 +0530 Subject: [PATCH] feature: Add structured GitHub Issue Templates (Fixes #368) Provides formalized YAML templates for bug reports and feature requests. Require users to provide OS, Python version, steps to reproduce, and core motivation. Complements the existing PR template and standardizes triage context. cc: @aliev @Nash0x7E2 @d3xvn --- .github/ISSUE_TEMPLATE/bug_report.yml | 68 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 39 +++++++++++++ 2 files changed, 107 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..d758d5da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,68 @@ +name: Bug Report +description: Create a bug report to help us improve. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report this bug! Please provide as much context as possible. + + - type: textarea + id: description + attributes: + label: Description + description: What happened? Please provide a clear and concise description of the bug. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: How can we reproduce this bug? + placeholder: | + 1. Install 'vision-agents' + 2. Run '...' + 3. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen instead? + validations: + required: true + + - type: input + id: python-version + attributes: + label: Python version + description: Which Python version are you using? (e.g., 3.11.4) + validations: + required: true + + - type: input + id: os + attributes: + label: Operating System + description: What operating system are you using? (e.g., macOS Sonoma, Ubuntu 22.04, Windows 11) + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..5613d880 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature Request +description: Suggest an idea for this project. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! Please explain your use case and proposed solution. + + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why is this feature necessary? What problem does it solve? + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposed Solution + description: Describe the solution you'd like. Be as specific as possible. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or workarounds? + + - type: checkboxes + id: contributions + attributes: + label: Willingness to contribute + options: + - label: I can contribute this feature myself! + required: false