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

Issue template improvements #4479

Merged
merged 5 commits into from
Aug 30, 2021

Conversation

kmk3
Copy link
Collaborator

@kmk3 kmk3 commented Aug 25, 2021

Make sections easier to see and edit.

By the way, I've intended to do this for a while, as I always thought that the
template looked rather crooked. I had assumed that it was just created from
scratch by hand like any other file, but recently I learned that GitHub is what
generates issue templates using such unusual markup for some reason. Now I see
that it's even mentioned in the commit that adds the template:

$ git show --pretty='%h %ai %s%n%n%b' --name-status bd29bf7202
bd29bf720 2020-04-07 16:40:07 -0500 Add bug report template

(Mostly) auto-generated with GitHub, will need tweaking over time

A       .github/ISSUE_TEMPLATE/bug_report.md

Cc: @Fred-Barclay (from the commit) @reinerh @rusty-snake (from #4468)

kmk3 added 5 commits August 25, 2021 15:04
Isolate each section title and each list from other elements, to make
them more visually distinguishable.  This should also make it easier to
find and edit only the parts that are meant to be edited.

See also the following discussion:
netblue30#4468
This properly separates the document into sections and makes the titles
stand out more.  It is also more consistent with what is generated by
GitHub issue forms (YAML).

See also the following discussion:
netblue30#4468
And put the code block inside of an HTML paragraph, so that it's not
just free floating after the `<summary>`.
Currently, the log portion seems to be part of the Checklist section.
@netblue30 netblue30 merged commit 1cf621c into netblue30:master Aug 30, 2021
@netblue30
Copy link
Owner

merged, thanks!

@kmk3 kmk3 deleted the issue-template-improvements branch August 30, 2021 14:46
kmk3 added a commit that referenced this pull request Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done (on RELNOTES)
Development

Successfully merging this pull request may close these issues.

4 participants