Repository navigation
feat(process): add structured issue forms for bug reports and feature requests - #464
legend91019 wants to merge 5 commits into
Conversation
… requests Add GitHub Issue Forms under .github/ISSUE_TEMPLATE/: - bug_report.yml: structured collection of version, OS/arch, install method, browser/extension version, exact command/API, reproduction steps, expected/actual behavior, sanitized logs, and regression tracking. - feature_request.yml: structured problem statement, proposed solution, alternatives considered, affected surfaces, and compatibility considerations. - config.yml: disable blank issues and route security reports to GitHub Security Advisories and questions to Discussions. Fixes Tencent#462
Address review feedback from issue Tencent#462: - Make relevant logs field in bug_report.yml optional to reduce friction when logs are unavailable. - Make affected CLI/API surface and compatibility considerations optional with N/A allowance in feature_request.yml.
NianJiuZst
left a comment
There was a problem hiding this comment.
Thanks for adding these forms. I think they will reduce the back-and-forth needed to reproduce bugs and help feature requests explain the underlying user problem. Keeping logs, the affected CLI/API surface, and compatibility considerations optional is a good choice.
Before merging, please make these small changes:
- In
.github/ISSUE_TEMPLATE/config.yml, remove the private vulnerability reporting and Discussions contact links. Both features are currently disabled for this repository, and the Discussions URL returns 404. We do not need either channel for now. - In
.github/ISSUE_TEMPLATE/bug_report.yml, remove the required security-vulnerability checkbox and its Security Advisories link. Keep the duplicate-search and sensitive-data redaction checks. - Set
blank_issues_enabled: trueso contributors can still report documentation issues or other problems that do not fit either form. - Update the PR description to reflect this scope: remove the claims about private security reporting and Discussions, and mention that blank issues remain available.
I checked the complete diff and parsed all three YAML files successfully. I have not exercised GitHub's actual form submission flow.
Please also confirm that Allow edits and access to secrets by maintainers is checked and keep it enabled so maintainers with write access can update the PR branch. GitHub currently reports maintainer_can_modify: true, so this appears to be enabled already.
… issues Per maintainer review: private vulnerability reporting and Discussions are disabled for this repository, so remove both contact links and the security-vulnerability checkbox (keeping duplicate-search and sensitive-data redaction checks), and set blank_issues_enabled: true so documentation and other issues still have a path.
|
Thanks for the careful review! All four points are addressed in
All three YAML files re-parse cleanly with CI update (2026-10-24): all 10 CI jobs are green on |
|
Closed and reopened to retrigger CI: the |
Summary
Fixes #462.
Adds GitHub Issue Forms under
.github/ISSUE_TEMPLATE/to standardize bug reports and feature requests, ensuring reporters provide actionable environment and reproduction details upfront. Blank issues remain available for documentation issues and other problems that do not fit either form.Changes
bug_report.yml:feature_request.yml:config.yml:blank_issues_enabled: trueso contributors can still file documentation issues or other problems that do not fit either form.Validation
bug_report.yml,feature_request.yml, andconfig.ymlwith Pythonyaml.safe_load().