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 bug report issue template #612

Conversation

agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Oct 9, 2020

Description

What this PR does / why we need it:

  • long logs of output or long configs are hard on the eyes and make it difficult to read through issues as they take up a lot of 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
  • I used this in an issue I've reported here and have also done this and implemented this in other repos

Tags

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
N/A

Can see examples of spoiler tag usage in my own #541

Can see examples of very long output logs and/or configs in #417, #424, etc

A similar example is in ezolenko/rollup-plugin-typescript2#244 as well.

Review Notes

Feel free to reject this if you don't think it'll be that useful in this context, thought I'd suggest it at least.

See Rendered Version
The spoiler tags aren't properly indented unfortunately. While you can indent them under the bullets, the logs themselves then need to be indented as well, which I think is too difficult for users and so will be ignored. If the logs aren't indented, then they don't make it into the spoiler tag anyway 😕 . So I think having them unindented and allowing for straight copy+paste is better, but does look a bit funky. Suggestions welcome.

- long logs of output or long configs are hard on the eyes and make it
  difficult to read through issues as they take up a lot of 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
- I used this in an issue I've reported here and have also done this
  and implemented this in other repos
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 9, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @agilgur5. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 9, 2020
@serathius
Copy link
Contributor

This is really great idea!! thanks
/lgtm
/approve
/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 9, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: agilgur5, serathius

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 9, 2020
@k8s-ci-robot k8s-ci-robot merged commit a3834a8 into kubernetes-sigs:master Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants