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.

Sign up for GitHub

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

Jump to bottom

Improve issue template #485

Merged
merged 7 commits into from
Aug 26, 2024
Merged

Improve issue template #485

merged 7 commits into from
Aug 26, 2024

Commits on Aug 26, 2024

  1. GitHub issue template: Remove part about ubuntu-bug authd 

    It currently doesn't provide a useful and well-formatted report. We want
to provide a command in the GitHub template instead to gather relevant
system information.

refs: #470
    @adombeck
    adombeck committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    1f368ad View commit details
    Browse the repository at this point in the history

  2. GitHub issue template: Remove some checkboxes 

    We want to simplify the issue template to make it easier to fill out.
I expect these checkboxes to not provide useful information in addition
to the issue description, so lets try removing them.
    @adombeck
    adombeck committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    6b2460b View commit details
    Browse the repository at this point in the history

  3. GitHub issue template: Fix link to troubleshooting wiki page

    @adombeck
    adombeck committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    0c1b670 View commit details
    Browse the repository at this point in the history

  4. GitHub issue template: Link to troubleshooting at the top 

    The main purpose of looking at the troubleshooting page is to help the
user to solve their issue themselves. If they are able to do that, they
don't need to fill out the rest of the form, so lets point to the
troubleshooting doc at the top.

The troubleshooting doc also explains how to enable debug logging. We
could also ask our users to do that and try to reproduce the issue with
debug logging, but that might be asking a bit much for non-technical
users, and is often not necessary to solve the issue, so lets instead
ask for that in a comment when we ascertain that we do need debug logs.
    @adombeck
    adombeck committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    05ee4ac View commit details
    Browse the repository at this point in the history

  5. GitHub issue template: Improve wording

    @adombeck
    adombeck committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    09449f4 View commit details
    Browse the repository at this point in the history

  6. GitHub issue template: Add command to show system information 

    To make it easier for the user to provide all the information we want.

This includes some rudimentary redaction of UUIDs like the issuer URL
and client ID.
    @adombeck
    adombeck committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    c26ccec View commit details
    Browse the repository at this point in the history

  7. GitHub issue template: Don't require steps to reproduce 

    We are trying to make the issue template easier to fill out. While steps
to reproduce are often very useful, there are issues which they don't
really apply to, or are not necessary. Lets try to make them not
required and see how it turns out.
    @adombeck
    adombeck committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    a64a3db View commit details
    Browse the repository at this point in the history