optimize: fix ISSUE_TEMPLATE not work#7370
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR addresses an issue with GitHub’s handling of issue templates by transitioning from Markdown (.md) to YAML (.yml) formatted templates and updating the configuration accordingly.
- Updated README reference to point to the YAML bug report template
- Added a new configuration file (config.yml) and YAML templates for bug reports and feature requests
- Removed outdated Markdown templates for feature requests and bug reports
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updated the bug report template reference to the YAML version |
| .github/ISSUE_TEMPLATE/config.yml | Added a new config file to enable blank issues |
| .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml | Added a new YAML template for feature requests |
| .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | Removed the outdated Markdown template for feature requests |
| .github/ISSUE_TEMPLATE/BUG_REPORT.yml | Added a new YAML template for bug reports |
| .github/ISSUE_TEMPLATE/BUG_REPORT.md | Removed the outdated Markdown template for bug reports |
Comments suppressed due to low confidence (2)
README.md:136
- The updated link in README.md points to the YAML bug report template. Please double-check that the path aligns with the repository structure and that users are aware of the format change.
Please follow the [template](./.github/ISSUE_TEMPLATE/BUG_REPORT.yml) for reporting any issues.
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md:1
- The removal of the Markdown feature request template appears intentional in favor of the new YAML template. Verify that any internal documentation referring to the Markdown template is updated accordingly.
-<!--
There was a problem hiding this comment.
It might be a good idea to create an Ask a question section and include a link to the apache mailing list there.
There was a problem hiding this comment.
Amazing! Added a link to discussion. When a user publishes a discussion, there will be automatic email announcements.
There was a problem hiding this comment.
Feature requests that impact the overall Roadmap should be submitted to the mailing list to enable broader discussion and collaboration.
There was a problem hiding this comment.
I think including both would be great!
As @slievrly mentioned, features that may impact the roadmap could go through the mailing list,
while questions related to the code itself might be better suited for GitHub Discussions, especially since Markdown can be used there.
There was a problem hiding this comment.
Feature requests that impact the overall Roadmap should be submitted to the mailing list to enable broader discussion and collaboration.
Our current email configuration is. asf.yaml, which can only automatically notify emails based on issue granularity, so I added a prompt word in Feature Request Issue Template to remind users to actively send emails.
Or do we have a better way?
Or should I set up a confirmation box to let the user confirm feature scope?
There was a problem hiding this comment.
I think it would be enough to simply add a mailing list url, like what’s done in JUnit 5’s config.yml.
(they add stackoverflow link)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 2.x #7370 +/- ##
============================================
- Coverage 58.49% 58.49% -0.01%
- Complexity 535 539 +4
============================================
Files 1272 1272
Lines 45862 45862
Branches 5522 5522
============================================
- Hits 26827 26825 -2
- Misses 16515 16518 +3
+ Partials 2520 2519 -1 see 5 files with indirect coverage changes 🚀 New features to boost your workflow:
|
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: Please do not use this issue template to report security vulnerabilities but refer to our [security policy](https://github.com/seata/seata/security/policy). |
There was a problem hiding this comment.
In the original template, it was displayed as a comment, which only hints at the author but doesn't show it when rendering.Can we achieve the same effect here?
There was a problem hiding this comment.
It is already so -> https://github.com/YoWuwuuuw/incubator-seata/issues
slievrly
changed the title
4 participants
Ⅰ. Describe what this PR did
Ⅱ. Does this pull request fix one issue?
fixes #7365
Ⅲ. Why don't you add test cases (unit test/integration test)?
Ⅳ. Describe how to verify it
The new creation process can go https://github.com/YoWuwuuuw/incubator-seata/issues
Ⅴ. Special notes for reviews
FEATURE_REQUEST looks like:
BUG_REPORT looks like:
