Skip to content

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 26, 2021
Merged

issue templates: better version prompt #11212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/bug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ assignees: ''

## Compiler version

``` bash
# get compiler version via command line
scalac -version
```
If you're not sure what version you're using, run `print scalaVersion` from sbt
(if you're running scalac manually, use `scalac -version` instead).

## Minimized code

Copy link
Contributor

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.

Copy link
Member Author

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.

Copy link
Member Author

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)

Copy link
Contributor

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.

Copy link
Member Author

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.

Copy link
Contributor

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 :)

Copy link
Member Author

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for taking care 👍

Expand Down
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/crash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ assignees: ''

## Compiler version

``` bash
# get compiler version via command line
scalac -version
```
If you're not sure what version you're using, run `print scalaVersion` from sbt
(if you're running scalac manually, use `scalac -version` instead).

## Minimized code

Expand Down
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/other-issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ assignees: ''

## Compiler version

``` bash
# get compiler version via command line
scalac -version
```
If you're not sure what version you're using, run `print scalaVersion` from sbt
(if you're running scalac manually, use `scalac -version` instead).

## Minimized example

Expand Down