search

vmware / .github

VMware Organizational .github directory
Other
7 stars 18 forks source link

Remove 'bash' rendering from bug report template #17

Closed rosenhouse closed 2 years ago

rosenhouse commented 2 years ago

Hi there,

Our team maintains the SplinterDB open-source project which inherits the issue templates from this repo.

The bug-report template has a "reproduction steps" section. Currently, it has the default-value (hint for contributor) of a Markdown list, but it renders as bash. This makes for awkwardness, especially when a contributor attempts to embed their own code-snippets in that section using Markdown syntax.

Below, I've attached a screenshot of an issue recently created by an outside contributor, who was trying to use the template, that demonstrates the problems.

This PR removes the bash rendering, so that the Reproduction Steps text field just renders as Markdown, the same as the other sections.

Screenshot of an issue-rendering problem that would be fixed by this PR:

image

geekygirldawn commented 2 years ago

This seems like a reasonable change to me. @warthog9 @avelichka - Do you know if there was a reason for rendering that section as bash instead of letting it default to Markdown?

warthog9 commented 2 years ago

No idea, something Eric did I'm content letting that flip back to default and letting folks manually adjust it from there should they wish