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

github: add spoiler tags to issue template #244

Merged
merged 1 commit into from
Oct 15, 2020

Conversation

agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented Oct 9, 2020

Description

  • long logs of output or long configs are hard on the eyes and make it
    difficult to read through issues as they just take up so much space

    • so it would be better, in my opinion, to hide them by default with
      spoiler tags, which can be opened up when further investigation is
      warranted
  • some issue authors have already used this pattern, this just brings
    it to the template itself so everyone (hopefully) starts using it

Tags

Can see examples of spoiler tag usage in #97, #148, and my own #212 (comment)

Can see examples of very long output logs and/or configs in #72, #85, #87, #194, #213, #217

Review Notes

Been meaning to write this PR for quite a while actually, finally got to it 😅

- long logs of output or long configs are hard on the eyes and make it
  difficult to read through issues as they just take up so much space
  - so it would be better, in my opinion, to hide them by default with
    spoiler tags, which can be opened up when further investigation is
    warranted

- some issue authors have already used this pattern, this just brings
  it to the template itself so everyone (hopefully) starts using it
@ezolenko ezolenko merged commit 4d2e7fd into ezolenko:master Oct 15, 2020
@agilgur5 agilgur5 added the scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI) label May 7, 2022
Repository owner locked as resolved and limited conversation to collaborators May 7, 2022
@agilgur5 agilgur5 added the kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs label May 26, 2022
@agilgur5 agilgur5 deleted the add-spoilers-to-issue-template branch July 2, 2023 21:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants