Skip to content
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

Update Issue Template #957

Merged
merged 6 commits into from
Dec 20, 2024
Merged

Conversation

BotBlake
Copy link
Contributor

Changed the Folder Structure from
./github/issue_template.md to ./github/ISSUE_TEMPLATE/issue_template.md
As per GitHub Documentation

Updated the existing Issue Template to have a defining header.
This allows it to appear in the Template Chooser.

This is created in response to #956 , so that Issues will from now on use the Template again.

If wanted, I can update the PR to:

  • Migrate from Markdown Template to yaml Issue Form
  • Configure the Template Chooser via config.yml file (as per docs)

The current state of the PR is only to fix what was broken.
However as per GitHub Docs, the old way of having the issue_template.md should have worked!

If you used the legacy workflow to manually create an issue_template.md file in the .github folder and enable blank issues in your config.yml file, the template in issue_template.md will be used when people choose to open a blank issue. If you disable blank issues, the template will never be used.

If you want to check if and how these changes work, feel free to checkout my fork on GH, on which I have set this branch to default to have an accurate Preview.

This comment was marked as off-topic.

Copy link
Member

@oddstr13 oddstr13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather have dropdowns, with the last option being «Other (please specify)»

None of the dropdowns should have default/pre-selected values, I don't want users to ignore the fields (they did with the old template).

Logs should probably be python code blocks, as python stack traces are expected (and possibly C# for the server logs)

It is unfortunate that there is no upload file option, as it is often preferable to have the log headers which print system info (would essentially duplicate several of the fields, such as OS and version)

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
@oddstr13
Copy link
Member

I personally think the «eg.» looks a bit strange (not often used in english?)

@BotBlake
Copy link
Contributor Author

The main issue with Dropdowns is, that there is no Option to do "Other, Please Specify" (at least not to my knowledge)
Thats why I didnt put Dropdowns, as requested, but rather Text fields directly.
I also experimented with having text-fields show up only if "other" was selected, but that also doesnt seem to be supported by GitHub.

However people will not be abled to "ignore" the fields, as they are marked as "required" - so something has to be filled in!

@oddstr13 oddstr13 merged commit 3e2ba9a into jellyfin:master Dec 20, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants