-
Notifications
You must be signed in to change notification settings - Fork 27.9k
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
An issue in the "Report Issue" dialog with a normal sized headline and one character in "Steps" section is too much data to send to github #82856
Comments
@jcollum-autodesk To open the new issue page on GitHub with data prefilled, we have to send data through the url query. We don't know what the default browser is, and for some browsers, a url that is too long will result in the page not loading. (There's also a bug with GitHubs login page and long urls even for browsers that don't have a restrictive character limit.) If we posted the data and actually created the issue on click instead, we
|
The system/extension information is probably the culprit. Maybe those should have a copy button for that information that shows after the issue is submitted? |
Yeah, that information is very long. I don't think separating out the step to include them is a good idea, though. That seems like it would just create more burden to the user, since you would have to go back and forth between the browser and VSCode copying information. |
No matter how you slice it I'm gonna have to do this in a 2 step process:
The process would be cleaner if it was clear that I won't be able to put in all the information necessary on the first pass. How about:
Alternately the flow could just ask me to write the issue out when I get to github's issue page. \ It looks like no matter what it's going to be a 2 step process. |
I'm a bit confused, as the flow you've described is what should happen currently. Perhaps the wording of the dialog could be made clearer? |
I was 100% expecting to be able to enter the issue and all the system information in that dialog box. I wasn't able to. That was surprising. POLA says that I should be able to put all the necessary info in that dialog, since there are places for all of it. I'm saying the workflow needs to be clearer -- I definitely have to do this in 2 passes, since even a few characters in the issue description will result in a failure. That's a limitation of github, which is outside of your control. I shouldn't be hitting failures as part of a normal workflow. |
Sorry, I'm still missing something here, I don't understand why 2 passes are needed. If you click the "Yes" button shown in the original screenshot, everything you have typed in the issue and all of the system information should be copied to the clipboard. The browser should be opened to GitHub and you can then paste it. The current message doesn't indicate that the GitHub issue page will still be opened, which is confusing |
But I typed one character, what's the use of that? Why have the textbox at all? If I am unable to actually type my "Steps to Reproduce" in to that dialog, what is the point of having that textbox there? It's confusing/misleading.
What? There's no message of any kind telling me that. 2 passes:
OR
I think the upshot of this is that the "Steps to Repro" dialog box is pointless since I can't use it and the system information is probably more important. |
Once again, I think the text of this message needs revising, but this is what I meant: The intended flow is that you
Yes, with even a small number of extensions installed the dialog is likely to appear, but it shouldn't prevent you from writing out the complete "Steps to Reproduce" and having that copied into the issue |
OK yeah I see the message you mean now. I only have like 6 extensions installed. I suspect that's a normal amount. Keeping that in mind I suspect most users will hit this message. The flow could be improved. If the list of extensions and system information is too large how about just replacing the "Steps" textbox with a message like "Too much data to send to github, your issue will be created but you'll have to enter Steps to reproduce after the issue is created." That way I know what's going to happen before I hit an error message. |
@jcollum-autodesk Can you please try pressing the "Yes" button in that dialog to understand the current flow? The dialog is not meant to prevent you from entering steps to reproduce |
I did that. But before that I trimmed off the "steps to reproduce" a few times to try to get it to fit. I was just thrown off by the error and assumed I had to trim down so it would work. I was being a bad user and just reacting to the first sentence. I think just changing the string would probably help, something like "This message is too large to send to github directly, please press Yes and we will copy it to your clipboard so you can paste it in to the description box on the github issue that we are about to create" Something like that but less wordy :D |
Yeah the first sentences does make it sound like it has completely failed. Thanks, I like your suggestion! |
Cool thanks for working through it with me |
This is the issue I was trying to report: #82855
I took the"Steps" section down to one character and I still got the above warning.
I'm sure there are reasons for this but the dialog doesn't seem very useful if it can't send an issue with system info and a single character in the dialog box. Maybe you need to refactor this UX.
The text was updated successfully, but these errors were encountered: