Improve issue templates - #40
Merged
Merged
Conversation
Migrate bug report and feature request templates to YAML-based GitHub Forms. This change introduces structured forms for bug reports, feature requests, and a new template for documentation suggestions. It provides specific input fields, dropdowns, and guidance to improve the issue reporting experience and ensure necessary information is captured upfront. Blank issues are now disabled, and a direct link to the script documentation has been added to the issue template chooser.
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Restore repository/tooling submission coverage and sanitization guidance before approval.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 2
Open (2)
What changed in this PR
This pull request improves GitHub issue templates for bug reports and feature requests and adds documentation issue intake.
Changes:
- Refines bug-report fields and reproduction guidance.
- Standardizes feature-request fields and requirements.
- Adds a documentation issue template.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/feature_request.yml |
Clarifies feature scope and requirements. |
.github/ISSUE_TEMPLATE/documentation.yml |
Adds documentation feedback fields. |
.github/ISSUE_TEMPLATE/bug_report.yml |
Improves bug-report structure and guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| label: Relevant output | ||
| description: Paste sanitized output, including the first error and surrounding lines, and the exit status if known. No code fences needed. | ||
| label: Relevant Output | ||
| description: Paste relevant output, including the first error and surrounding lines. |
Comment on lines
9
to
12
| label: Scope | ||
| multiple: true | ||
| options: | ||
| - Improve an existing script | ||
| - Add a new standalone script |
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
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.
This pull request updates the GitHub issue templates to improve clarity, usability, and coverage for bug reports, feature requests, and documentation suggestions. The changes standardize form fields, enhance descriptions and guidance, and add a new template specifically for documentation issues.
Issue template improvements:
.github/ISSUE_TEMPLATE/bug_report.yml: Refined field labels and descriptions for clarity, split expected and actual behavior into separate fields, and improved guidance for environment details and reproduction steps..github/ISSUE_TEMPLATE/feature_request.yml: Standardized field names, clarified descriptions, added a required field for target environment and requirements, and improved guidance for alternatives and proposals.New documentation template:
.github/ISSUE_TEMPLATE/documentation.yml: Added a new template for suggesting documentation corrections, clarifications, or additions, including fields for scope, affected documentation, reason, proposal, and context.