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

feat: overhaul issue templates #1667

Merged
merged 4 commits into from
Jun 26, 2024
Merged

feat: overhaul issue templates #1667

merged 4 commits into from
Jun 26, 2024

Conversation

realguse
Copy link

Description

This PR overhauled the issue templates. It changed them to issue template forms and fixed mistakes and consistency.

Requirements / Checklist

  • Read the Contributing Guidelines
  • I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan.
    Issue number where discussion took place: #xxx
  • If this contains a font/glyph add its origin as background info below (e.g. URL)
  • Verified the license of any newly added font, glyph, or glyph set. License is: xxx

What does this Pull Request (PR) do?

This PR changes the format of the issue templates and fixes mistakes.

How should this be manually tested?

It can be manually tested by clicking the New Issue button in the Issues tab and selecting one of the categories

Any background context you can provide?

What are the relevant tickets (if any)?

Screenshots (if appropriate or helpful)

bug_report_template feature_request_template

@realguse realguse changed the title Overhaul issue template feat: overhaul issue templates Jun 25, 2024
Copy link
Collaborator

@Finii Finii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the nice PR!

This looks very good! I have two comments, though:

  1. In the bug report terminal emulator field the text gets truncated (in your screenshots as well as in my tests); of course this depends on the actually used fonts etc, but maybe we should make it a bit shorter.
    I would suggest using kitty instead of gnome-terminal, which probably fits and according to the issue frequency is more used.
  2. The checkboxes are now all mandatory, which means you can not press the submit button until all checkboxes are ticked.
    I guess when people are honest and did not do all the stuff, and then want to submit, they just tick the other ones, because, well, it is required. Maybe it is better to let these non-required to get honest answers to the questions. Of course they should all be checked but just forcing people to check them can have diametrical effects I fear?
    What do you think?

@Finii
Copy link
Collaborator

Finii commented Jun 26, 2024

@allcontributors please add @gu5e for doc

Copy link
Contributor

@Finii

I've put up a pull request to add @gu5e! 🎉

@Finii
Copy link
Collaborator

Finii commented Jun 26, 2024

I would also add these comments somehow, because frequently people do not add screenshots at all (which makes reproduction very hard) or snip just a very small fraction of the screen...

<!-- Provide screenshots where appropriate, they help tremendously -->
<!-- Try to include the title of terminal windows and possibly settings dialogues -->

Previously this section has been called 'Screenshots' explicitely, for the same reasons:

image

@Finii
Copy link
Collaborator

Finii commented Jun 26, 2024

Example of people ticking all tickboxes, although it is not true...

image

(There was no previous discussion, it is ticked nonetheless 😬 )

@realguse
Copy link
Author

I have tried to address most of the things you pointed out @Finii (sorry for the accidental ticking btw, ill be sure to do it next time)

@Finii
Copy link
Collaborator

Finii commented Jun 26, 2024

sorry for the accidental ticking btw, ill be sure to do it next time

:-D no problem at all, ppl do it all the time

Thanks for the PR, I will fix one small thing an then merge.
👍

[why]
Make sure the examples are understood correctly and add some more info.

Signed-off-by: Fini Jastrow <[email protected]>
@Finii Finii merged commit 11ab942 into ryanoasis:master Jun 26, 2024
@Finii
Copy link
Collaborator

Finii commented Jun 26, 2024

Thank you! 💚

@Finii Finii mentioned this pull request Aug 27, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants