Add template for Q&A discussions #1070
Conversation
|
Cool! I see it's being triggered when |
|
It works a bit differently: it gets triggered when you start a Q&A discussion, presents the user with a custom form and automatically adds the "help wanted" label (the user can of course remove that before or after posting). You can try that out in the fork. There should be no configuration necessary, when a discussion is started, GitHub will automatically look for a yaml file in the |
.github/DISCUSSION_TEMPLATE/q-a.yml
Outdated
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This is the place to ask for specifics about flet or for help with problems you encountered while using it. |
There was a problem hiding this comment.
Could you change flet to Flet please?
* feat: Add discussion template for Q&A * refactor: Test if "general" makes the template available * refactor: test if omitting some fields breaks the template * fix: the previous commit broke the template, next test * fix: maybe explicit empty strings will be accepted * fix: step by step testing continues... * fix: Xs instead of empty strings everywhere * refactor: next round of testing * refactor: try different name for q&a * refactor: try qa.yml * refactor: try q-a.yml * refactor: Word a description better * refactor: Change up order * fix: fix label (hopefully) * style: Change "your question" to "question" * style: Change "flet" to "Flet"
* feat: Add discussion template for Q&A * refactor: Test if "general" makes the template available * refactor: test if omitting some fields breaks the template * fix: the previous commit broke the template, next test * fix: maybe explicit empty strings will be accepted * fix: step by step testing continues... * fix: Xs instead of empty strings everywhere * refactor: next round of testing * refactor: try different name for q&a * refactor: try qa.yml * refactor: try q-a.yml * refactor: Word a description better * refactor: Change up order * fix: fix label (hopefully) * style: Change "your question" to "question" * style: Change "flet" to "Flet"
Since discussions within that category are mostly help requests and I frequently find myself having to ask for more info from the OP, e.g. an error message or a code sample, I thought it would be nice to have a template. It can be seen in action on this fork.
The GitHub discussion category form feature is in public beta, so this template might suddenly not work anymore because GitHub changed the syntax or something else broke. It is my understanding though that in that case the default template would simply be chosen, so it wouldn't be a major inconvenience.
Apologies that it's 15 commits when it could have been 1 or 2, it was a trial and error process and much to my disdain, GitHub didn't document what the category slug for categories containing an "&" is.