Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Conversation

@caleb-johnson
Copy link
Collaborator

We have improved the bug report issue template, and I would like to get it in QRAO before release. Let me know what you think of this

Copy link
Member

@garrison garrison 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 prefer if the instructions are in HTML comments.

I think I'd also prefer that the toplevel headings be ## (if not ###).


## Steps to Reproduce

Please provide detailed steps for reproducing the issue. A simple, runnable code-snippet is highly preferred.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Please provide detailed steps for reproducing the issue. A simple, runnable code-snippet is highly preferred.
Please provide detailed steps for reproducing the issue. A simple, runnable code snippet is highly preferred.

@caleb-johnson
Copy link
Collaborator Author

I'd prefer if the instructions are in HTML comments.

I think I'd also prefer that the toplevel headings be ## (if not ###).

Are HTML comments visible in the template? I figured we would want users to see all the text in there.

@garrison
Copy link
Member

They're as visible as the old

<!-- ⚠️ If you do not respect this template, your issue will be closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues -->

which is to say a person sees them when filing a bug but not again after that point (Which I think is what we want here).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants