Skip to content

Commit c481e91

Browse files
kubukozsom-snyttGedochao
authored
Update bug issue template (#23148)
The suggestion to try nightlies would've saved me about 10 minutes because I would've seen @som-snytt already fixed #22901... [skip ci] --------- Co-authored-by: Som Snytt <[email protected]> Co-authored-by: Piotr Chabelski <[email protected]>
1 parent 76bd5c7 commit c481e91

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

.github/ISSUE_TEMPLATE/bug.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,33 @@ assignees: ''
99

1010
## Compiler version
1111

12-
If you're not sure what version you're using, run `print scalaVersion` from sbt
13-
(if you're running scalac manually, use `scalac -version` instead).
12+
If you're not sure which version you're using, run `print scalaVersion` from sbt.
13+
(If you're running scalac manually, use `scalac -version` instead.)
14+
15+
If possible, check if your issue appears in the nightly version of the compiler! For example, in Scala CLI (the `scala`/`scala-cli` runner script), you can use `//> using scala 3.nightly` (or `-S 3.nightly` from the command line) to grab the latest one.
1416

1517
## Minimized code
1618

1719
<!--
1820
This code should be self contained, compilable (with possible failures) and as small as possible.
1921
20-
Ideally, we should be able to just copy this code in a file and run `scalac` (and maybe `scala`) to reproduce the issue.
22+
Ideally, we should be able to just copy this code to a file and run `scalac` (and maybe `scala`) to reproduce the issue.
23+
24+
If the code has external dependencies, please provide the Scala CLI directives (or SBT/other build tool configuration) that describe them.
25+
Also note that it's easier and faster for the maintenance team to address issues minimised to reproduce bugs without external dependencies.
26+
27+
It's most convenient to also include `using` directives for the Scala version that demonstrates the problem,
28+
any compiler command-line options, as well as dependencies. An example is provided.
29+
30+
It's also fine to paste the transcript of a REPL session. Note that some bugs may be specific to the REPL.
2131
-->
2232

23-
```Scala
24-
println("hello, world")
33+
```scala
34+
//> using scala 3.7.0
35+
//> using options -Wall -Werror
36+
//> using dep com.outr::scribe:3.16.1
37+
38+
@main def test = println("hello, world")
2539
```
2640

2741
## Output

0 commit comments

Comments
 (0)