Skip to content

feature: Add structured GitHub Issue Templates (Fixes #368) #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aniruddhaadak80 wants to merge 1 commit into
base: main
Choose a base branch
from
+107 −0
Open

feature: Add structured GitHub Issue Templates (Fixes #368) #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Comment on lines +39 to +53
Copy link

@coderabbitai coderabbitai bot Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add a vision-agents package version field alongside the Python version.

The template asks for Python version and OS but omits the vision-agents library version itself, which is the most critical piece of context for reproducing version-specific bugs.

✨ Suggested addition 
   - 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: package-version
+    attributes:
+      label: vision-agents version
+      description: Which version of vision-agents are you using? (e.g., 0.1.2)
+    validations:
+      required: true
+
   - type: input
     id: os
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/ISSUE_TEMPLATE/bug_report.yml around lines 39 - 53, Add a new
required input field for the vision-agents package version next to the existing
Python version field: create an input block with id "vision-agents-version",
label "vision-agents version", a short description like "Which vision-agents
package version are you using? (e.g., 1.2.3)", and set validations.required:
true so the bug report captures the library version along with the existing
"python-version" and "os" inputs.


- 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
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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