-
-
Notifications
You must be signed in to change notification settings - Fork 389
Add ISSUE_TEMPLATE for github #305
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
Conversation
Pretty sure we could have a tool that would produce a report for some of those values.
These ones are fairly easy to automatically get. |
Indeed, we could incorporate some of these into |
Would we re-invent the wheel if we add something like a |
Probably the most sensible thing to do would just be to print the versions/which tools are installed to stderr when |
@bubba I am preparing a patch. |
0f6f19e
to
df7b657
Compare
df7b657
to
767c388
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.
LGTM :)
767c388
to
ca9a54d
Compare
Describe your issue here. | ||
|
||
### Your environment | ||
* Output of `haskell-language-server --probe-tools` or `haskell-language-server-wrapper --probe-tools` |
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 should mention that this cli flag is not available in the latest release? Or wait till the next release?
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 think even after we release the next version, this template should mention the version range in which this command is available. If not, some users will try to run those command with outdated HLS, and then may think this issue template is outdated (or somewhat broken) hence ignore the template.
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.
My only concern is that we will not have issues reported, because people will take a look at the huge amount of info we ask for, and run.
Maybe we should say that the part from Steps to reproduce
onward should be filled in if possible? It is not always easy / possible to reproduce an issue, especially if it in on a private code base.
@alanz While I kind of agree, we also need that kind of information if there are bugs. Even on a private code-base, we can not help or debug at all, if not at least big parts of these informations are given. However, I agree that we can make it more clear that most of it is optional and that we dont close issues just because they dont follow that template. |
@fendor I agree, but I think raising the issue, and giving the environment can be useful in some cases. And perhaps we should say that if they can repro do that, but if not still report. Some bugs are straightforward to fix, without the repro, no need to put people through that pain if it is not needed. |
ca9a54d
to
250e49b
Compare
250e49b
to
96d930c
Compare
Small adaptations to make it clear that the information asked for is optional and may be omitted. |
* Remove JSON instances for completions, since we are not implementing "resolve" * Remove completion resolve data from tests
The purpose would be to reduce the amount of back and forths we usually ask before we can properly answer a question.
It might be overkill to ask that much information.