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

doc: Update bug report issue template with new YAML format #4793

Merged
merged 6 commits into from
Jul 11, 2022

Conversation

slarse
Copy link
Collaborator

@slarse slarse commented Jul 9, 2022

There's new templating functionality for issues that uses YAML to produce much better structured forms for issues. I figured we should try it out. One of the biggest perks is that code formatting is automatic, reporters just need to paste in code, no need for backticks.

This can be considered a draft, feel free to suggest changes.

@MartinWitt @monperrus @SirYwell @I-Al-Istannen

Copy link
Collaborator

@I-Al-Istannen I-Al-Istannen left a comment

Choose a reason for hiding this comment

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

Thanks! I was looking at that every few weeks whenever an issue was opened :P I didn't realize they are out of beta yet.

I have left a few things that came to mind while skimming the new template.

.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
@MartinWitt
Copy link
Collaborator

MartinWitt commented Jul 9, 2022

How about adding the used JVM version string as needed information? Otherwise, looks wonderful.

@slarse
Copy link
Collaborator Author

slarse commented Jul 10, 2022

How about adding the used JVM version string as needed information? Otherwise, looks wonderful.

Of course that should be in there as well. It just somehow slipped my mind. Will add.

@slarse
Copy link
Collaborator Author

slarse commented Jul 11, 2022

@MartinWitt Ready for re-review!

@MartinWitt
Copy link
Collaborator

MartinWitt commented Jul 11, 2022

LGTM, let's see how the users like it? Always highlighted source code seems astonishing.
Edit: I have merged it now because we can easily change this anytime we want, if we see there is something missing.

@MartinWitt MartinWitt changed the title review: doc: Update bug report issue template with new YAML format doc: Update bug report issue template with new YAML format Jul 11, 2022
@MartinWitt MartinWitt merged commit 9111edf into INRIA:master Jul 11, 2022
@slarse slarse deleted the use-new-issue-template branch July 11, 2022 17:13
@slarse
Copy link
Collaborator Author

slarse commented Jul 11, 2022

Edit: I have merged it now because we can easily change this anytime we want, if we see there is something missing.

Yep. I had a quick peek and it looks pretty reasonable. Perhaps a bit large with all of the different "input, spoon code, output, expected output" stuff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants