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 simple issue templates & configuration #1488
Conversation
8991000
to
afbe194
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty neat!
I was thinking that we needed issue templates too.
This will make a great improvement.
May I know why we choose to make no mention of CZO?
a) I understand we wouldn't want to lose bug reports getting submerged in CZO and that users don't need to have a CZO account, but can't we mention CZO ZT stream as an option if they're not sure about how to reproduce their bug?
b) I noticed zulip/zulip seems to have a separate template for issues discussed in CZO. But, yeah, there's no associated label and it only contains a hint/reminder to link a CZO message instead of a topic and to link back the created issue, but that could be useful too?
nit: Regarding the categories,
sometimes and for some users the border between a major and a minor bug may not be very distinct (despite the description).
But, I guess that margin of error would still be fine.
.github/ISSUE_TEMPLATE/02_bug.md
Outdated
- **Operating system (and version):** | ||
eg. Debian Linux, Ubuntu Linux, macOS, WSL in Windows | ||
|
||
If possible, please provide details from the `About` menu: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can also add the shortcut (Meta + ?) for the About Menu?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, sounds reasonable - though we'll need to update this once we know how we're going to express Meta
consistently.
If possible, please provide details from the `About` menu: | |
If possible, please provide details from the `About` menu (<kbd>Meta</kbd>+<kbd>?</kbd>): |
|
||
|
||
|
||
### How are you running the application? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would we also want to ask for the Python version and implementation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of these are listed in the About menu, so it's difficult to know whether to include these in the top part or beneath that.
The reason I included these separately is
- in case users cannot access the about menu
- if we later add a 'copy' option to the about menu for this kind of reporting :)
The python details could probably go here, but may want to be freeform - maybe multiple versions have been tested?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh yeah, we could mention that these details can all be found in the About menu, at the starting of that section. Since one can't assume that, if they do not know.
Nice ideas! I didn't account for these possibilities.
.github/ISSUE_TEMPLATE/02_bug.md
Outdated
Please include at least: | ||
- **Zulip-terminal version:** | ||
eg. a specific version (0.7.0), or if running from `main` also ideally the git ref | ||
- **Zulip server version:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed that you chose to drop the checkbox list for Zulip server versions.
I'm not quite acquainted with the server versions yet.
But, would the same checkbox not apply for ZT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See the 'parity' file, which links to the API changelog for some server versions.
I will add chat.zulip.org as one of the Zulip server suggested version options.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could add each server version, but we've historically aimed to support from 2.1 onwards. That doesn't mean we support every feature that web has, but we've not dropped support for older server versions. For that reason the list of server versions to select from wouldn't be 8/7/6/5(orless), but more like 8/7/6/5/4/3/2.1. That's only two more options, but it might make the list a little long, and even longer with new releases ;)
afbe194
to
6b1e439
Compare
@Niloth-p Does the fixup commit address your suggestions? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@neiljp That's a lot more improvements than I was able to imagine 😃
@@ -8,6 +8,9 @@ labels: bug: crash, | |||
|
|||
|
|||
|
|||
<!-- If discussed in #zulip-terminal or another channel on chat.zulip.org, paste link below: --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh yeah, this is a great idea to just add it to all of the templates.
Do we also want to mention that it's better for them to link the message instead of the topic, as they could be moved?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did consider this, but I didn't want to get too technical for issue filing - ie. a link is a good starting point if not familiar with Zulip.
For ZT in particular, we could even simplify it back to something like 'name of topic', since we don't have a 'copy link to message' (or topic, or stream) as yet.
I'm inclined to leave this as a followup for now.
.github/ISSUE_TEMPLATE/02_bug.md
Outdated
|
||
If possible, please provide details from the `About` menu: | ||
If possible, please provide details from the `About` menu: (Meta + ?) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We might want to mention or clarify that the part in the brackets is the hotkey to access it.
It may not be obvious, as 'meta' and '?' are not just keys.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I dropped the <kbd>
tags from the text as discussed previously, since they are only visible when previewed/submitted, so are a bit messy when filling out the original box.
Just added a hotkey:
prefix before the keys.
Pushed a few more minor changes. Will look at this again later, but I'd like to squash and merge this to get some real-life testing going, so we can iterate further if necessary. |
This adds basic issue templates to support the automatic labelling of reported issues, and some structure to guide users towards useful information to report. This doesn't use forms, much like in the main zulip/zulip repository, and also supports filing blank issues, since the structure is not necessary for each case.
0ee3fc9
to
c169f8b
Compare
What does this PR do, and why?
This converts the basic issue filing system to use the GitHub template chooser.
The main feature at this point is to focus reporters on the scope of the issue:
These should apply a corresponding default label to the issue, with the idea that this would provide an initial structure to fine-tune the labels, eg. a specific
parity
label to add tomissing feature
, which could also gain one of theuser
oradmin
sub-labels.This already feels like an improvement over the current single blank 'template', though it may take time to see how it works in practice.
This takes some ideas from zulip/zulip#26000 and followups.
Outstanding aspect(s)
External discussion & connections
Issue types #T1488
How did you test this?
Self-review checklist for each commit