Issue template that just adds intro markdown? #198759
Replies: 1 comment
-
|
💬 Your Product Feedback Has Been Submitted 🎉 Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users. Here's what you can expect moving forward ⏩
Where to look to see what's shipping 👀
What you can do in the meantime 💻
As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities. Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐ |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
🏷️ Discussion Type
Product Feedback
💬 Feature/Topic Area
Issues
Body
Hi, I think I'm in the right place for this (and yes, this is feedback about GitHub Issues and not an issue with GitHub).
Okay, so we get a lot of common bug reports we'd rather not--questions better asked elsewhere, memory leak reports that aren't from us, etc--so we want to add some custom intro markdown to the "New Issue" page. We don't want to add it as default text to the textarea where the bug reports will go, because it'll show as markdown text instead of HTML and we don't want people to have to delete it.
So I've set out to create the most minimal issue template I could:
And config.yml is simply:
...so we don't get a popup between "Bug Report" and "Blank Issue" when the user clicks "New Issue."
The hope is to otherwise look exactly like the standard GitHub issue page, but we can't quite get there:
First, there's now a "Bug Report · Choose a different template" line, which feels like it should not be there if we have no other options (indeed, the "New Issue" button itself seems to realize this and skip the template chooser UI).
Second: we do have the template chooser UI pop up if a project maintainer shows up, and we would rather it not, since it adds an extra click for the people doing the most work. A config.yml option to turn that off would be appreciated.
Third: this is the thing that is actually stopping me here...if you fill out the page and submit it, here's what goes in the issue tracker:
I really don't want the textarea's label included in the submitted bug report text.
Fourth: I don't want to enter text for any standard components, under the hope that GitHub will show correctly-localized text to the user for things like "Add a description". Additionally, while I'm sure GitHub itself is more localized than we could ever hope to be, it might be nice for us to be able to provide localized translations of our intro markdown text, but that's extra credit.
But all of this to say: these are minor tweaks to the existing feature that might be useful, but it might also be useful if there were a way to configure it as "I want the standard GitHub Issues page with no changes except this intro markdown text, for things we want the user to know before going further."
If I'm missing obvious solutions here, I won't be offended if you let me know. Thanks!
Guidelines
Beta Was this translation helpful? Give feedback.
All reactions