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

Add ISSUE_TEMPLATE for github #305

Merged
merged 1 commit into from Sep 1, 2020
Merged

Conversation

fendor
Copy link
Collaborator

@fendor fendor commented Aug 10, 2020

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.

@Kleidukos
Copy link
Member

Pretty sure we could have a tool that would produce a report for some of those values.

* Version of haskell-language-server
* Version of cabal
* Version of ghc
* Version of stack

These ones are fairly easy to automatically get.

@fendor
Copy link
Collaborator Author

fendor commented Aug 10, 2020

Indeed, we could incorporate some of these into haskell-language-server themselves.
Maybe we should also mention haskell-language-server-wrapper as well?

@fendor
Copy link
Collaborator Author

fendor commented Aug 10, 2020

Would we re-invent the wheel if we add something like a --probe-tools command for hls?

.github/ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
@lukel97
Copy link
Collaborator

lukel97 commented Aug 10, 2020

Probably the most sensible thing to do would just be to print the versions/which tools are installed to stderr when haskell-language-server[-wrapper] is run

@fendor
Copy link
Collaborator Author

fendor commented Aug 10, 2020

@bubba I am preparing a patch.

Copy link
Member

@Ailrun Ailrun left a comment

Choose a reason for hiding this comment

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

LGTM :)

.github/ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
Describe your issue here.

### Your environment
* Output of `haskell-language-server --probe-tools` or `haskell-language-server-wrapper --probe-tools`
Copy link
Collaborator Author

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?

Copy link
Member

@Ailrun Ailrun Aug 14, 2020

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.

Copy link
Collaborator

@alanz alanz left a 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.

@fendor
Copy link
Collaborator Author

fendor commented Aug 10, 2020

@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.

@alanz
Copy link
Collaborator

alanz commented Aug 10, 2020

@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.

@fendor
Copy link
Collaborator Author

fendor commented Aug 23, 2020

Small adaptations to make it clear that the information asked for is optional and may be omitted.
@alanz Is that better, or should we add more clarifications?

@alanz alanz merged commit 5777e8d into haskell:master Sep 1, 2020
pepeiborra pushed a commit that referenced this pull request Dec 27, 2020
* Remove JSON instances for completions, since we are not implementing "resolve"

* Remove completion resolve data from tests
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.

None yet

6 participants