-
Notifications
You must be signed in to change notification settings - Fork 1.1k
issue templates: better version prompt #11212
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
## Minimized code | ||
|
||
Using Scala (add version here, if you're not sure check with `sbt "print scalaVersion"`), | ||
|
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 encourage programmers to minimize, using SBT for minimization is awkward. I think at least we should list scalac
as a way to get compiler 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.
It's much easier to minimize by using your normal build tool than by trying to replace it by scalac, and I think that if they're using scalac by hand, they know which version they've installed, but feel free to add a suggestion with the text you'd like to add here.
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.
(https://github.com/scala/bug/blob/master/.github/ISSUE_TEMPLATE/bug.md doesn't list any command and it doesn't seem to be a problem)
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.
If you want to add sbt
and/or mill
, maybe just add more lines to the code block.
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.
Since the current situation is confusing (cf #11211), adding more lines of code is likely to make it more confusing I think, maybe there's a better way to describe things but I would rather remove things that add more things.
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.
If a reporter only uses sbt
, I think it's fair enough to add sbt "print scalaVersion"
as a way to get compiler version. I think we can trust programmers who bother to report a bug can figure out the version if we give enough tips (I assume most of them are professional programmers).
Meanwhile, if they don't know scalac
before, it's good to know and learn that as a Scala programmer --- a reward for bug report :)
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.
OK, I've tried to find a wording which keeps both commands without being too confusing.
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.
Thanks for taking care 👍
Give the sbt command for finding the current version, this avoids confusion like in scala#11211.
e9e5ce3
to
b184a71
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
Almost no one uses
scalac
by hand, so it's not a good way to get thecurrent compiler version (example:
#11211), give the sbt command
instead.