feature: Add structured GitHub Issue Templates (Fixes #368)#369
Open
aniruddhaadak80 wants to merge 1 commit intoGetStream:mainfrom
Open
feature: Add structured GitHub Issue Templates (Fixes #368)#369aniruddhaadak80 wants to merge 1 commit intoGetStream:mainfrom
aniruddhaadak80 wants to merge 1 commit intoGetStream:mainfrom
Conversation
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
📝 WalkthroughWalkthroughAdds two GitHub issue templates (bug report and feature request) to enforce structured forms for issue submissions. Bug reports collect reproduction steps, environment details, and logs; feature requests capture motivation, proposals, and contribution willingness. Both templates include required fields and default labeling. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/ISSUE_TEMPLATE/feature_request.yml (2)
33-39:required: falseis the default and can be omitted.GitHub's form schema allows setting
requiredper individual checkbox option, butfalseis the default, making this declaration redundant noise. Drop the key to keep the template clean.♻️ Suggested cleanup
options: - label: I can contribute this feature myself! - required: false🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/ISSUE_TEMPLATE/feature_request.yml around lines 33 - 39, Remove the redundant "required: false" property from the checkboxes option under the "contributions" field (type: checkboxes, id: contributions, option label: "I can contribute this feature myself!") since false is the default; simply delete that key from the option to keep the template clean.
1-39: Consider adding a Code of Conduct checkbox for consistency withbug_report.yml.The bug report template requires CoC acknowledgement (
termscheckbox,required: true), but the feature request template has no such field. If CoC agreement is a project-wide policy, both templates should enforce it uniformly.✨ Suggested addition
options: - label: I can contribute this feature myself! - required: false + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + options: + - label: I agree to follow this project's [Code of Conduct](https://github.com/GetStream/Vision-Agents/blob/main/CODE_OF_CONDUCT.md) + required: true🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/ISSUE_TEMPLATE/feature_request.yml around lines 1 - 39, Add a required Code of Conduct checkbox to the feature request template by inserting a checkboxes entry in the body that mirrors the bug report behavior: add an entry with id: terms, attributes.label set to a CoC acknowledgement (e.g., "I agree to the Code of Conduct"), options containing that single checkbox, and validations/required: true so the field blocks submission until checked; place this new checkboxes block alongside the existing body fields (motivation, proposal, alternatives, contributions) to ensure consistent enforcement.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/ISSUE_TEMPLATE/bug_report.yml:
- Around line 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.
---
Nitpick comments:
In @.github/ISSUE_TEMPLATE/feature_request.yml:
- Around line 33-39: Remove the redundant "required: false" property from the
checkboxes option under the "contributions" field (type: checkboxes, id:
contributions, option label: "I can contribute this feature myself!") since
false is the default; simply delete that key from the option to keep the
template clean.
- Around line 1-39: Add a required Code of Conduct checkbox to the feature
request template by inserting a checkboxes entry in the body that mirrors the
bug report behavior: add an entry with id: terms, attributes.label set to a CoC
acknowledgement (e.g., "I agree to the Code of Conduct"), options containing
that single checkbox, and validations/required: true so the field blocks
submission until checked; place this new checkboxes block alongside the existing
body fields (motivation, proposal, alternatives, contributions) to ensure
consistent enforcement.
Comment on lines
+39
to
+53
| - 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 |
There was a problem hiding this comment.
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.
Member
|
Thank you for your PR @aniruddhaadak80, we will review internally. cc: @dangusev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #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
Summary by CodeRabbit
Chores