-
Notifications
You must be signed in to change notification settings - Fork 20.5k
Docs: Create Bug and Feature Request Forms #5651
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.
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
base: main
Are you sure you want to change the base?
Conversation
|
Thanks for the PR. Please sign our CLA, we cannot merge contributed code otherwise. |
Done! |
mgol
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR.
I tried this on my fork but it doesn't work. I recommend you to temporarily enable issues on your jQuery fork and to set the patch-1 branch as the main one and you'll be able to check what's needed. In particular, I think we need a config.yml file: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
Also, if we want to introduce a feature request form, please make sure the path to report regular bug reports is at least not harder than it was - maybe we need to create a form for bug reports as well, even if for now it won't ask that many questions (we can always improve it later)?
I had done this before creating the PR. Not sure what's the issue is about. I'll look into the link you shared.
I'll add in this PR itself |
| name: Bug Report | ||
| description: Report a bug encountered in JQuery. | ||
| title: "[BUG]: " | ||
| labels: ["bug", "triage"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we want these labels.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have Bug (starting with an uppercase letter) in Core, we could add it here as well. The Refined GitHub extension adds a separate tab for issues with such a label.
Agreed about triage.
| name: Feature Request | ||
| description: Request a feature to be added to JQuery. | ||
| title: "[FEAT]: " | ||
| labels: ["enhancement", "triage"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No new labels required. We have other labels for this.
|
| @@ -0,0 +1,26 @@ | |||
| name: Bug Report | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's use consistent naming, BTW. This file is named bug_report.yml, the other one is Feature Request.yml. I'd prefer bug-report.yml & feature-request.yml, it'd be more consistent with how we name files.
| id: wiki | ||
| attributes: | ||
| label: Have you checked existing issues? | ||
| description: Before submitting this issue, please check if a similar issue has been raised in the repository [here](https://github.com/jquery/jquery/issues?q=is%3Aissue%20label%3ABug%20). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid linking from generic text like "here", it's bad for accessibility: https://granicus.com/blog/why-click-here-links-are-bad/



Summary
Fixes #5650
Adds a new Issue Form for Feature Requests
Checklist