From bce922a028762e1f343d07f7be4ec2cb24469e4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Koz=C5=82owski?= Date: Tue, 13 May 2025 23:35:11 +0200 Subject: [PATCH 1/4] Update bug issue template --- .github/ISSUE_TEMPLATE/bug.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 6e53805900c4..a49141bf0653 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -12,6 +12,8 @@ assignees: '' 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). +If possible, check if your issue appears in the nightly version of the compiler! For example, in scala-cli, you can use `//> using scala 3.nightly` to grab the latest one. + ## Minimized code -```Scala +```scala println("hello, world") ``` From 041b21177b24903d28f48f75b4e2aa3de6b90794 Mon Sep 17 00:00:00 2001 From: Som Snytt Date: Tue, 13 May 2025 18:28:40 -0700 Subject: [PATCH 2/4] Too many words? --- .github/ISSUE_TEMPLATE/bug.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index a49141bf0653..3f42c94706b4 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -9,8 +9,8 @@ assignees: '' ## Compiler 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). +If you're not sure which version you're using, run `print scalaVersion` from sbt. +(If you're running scalac manually, use `scalac -version` instead.) If possible, check if your issue appears in the nightly version of the compiler! For example, in scala-cli, you can use `//> using scala 3.nightly` to grab the latest one. @@ -19,11 +19,22 @@ If possible, check if your issue appears in the nightly version of the compiler! ```scala -println("hello, world") +//> using scala 3.7.0 +//> using options -Wall -Werror +//> using dep com.outr::scribe:3.16.1 + +@main def test = println("hello, world") ``` ## Output From a3e8803d84a20f36003681fb877478d2eb9a0985 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Koz=C5=82owski?= Date: Thu, 15 May 2025 13:43:43 +0200 Subject: [PATCH 3/4] Update bug.md Co-authored-by: Piotr Chabelski --- .github/ISSUE_TEMPLATE/bug.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 3f42c94706b4..1f523fca796e 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -12,7 +12,7 @@ assignees: '' If you're not sure which version you're using, run `print scalaVersion` from sbt. (If you're running scalac manually, use `scalac -version` instead.) -If possible, check if your issue appears in the nightly version of the compiler! For example, in scala-cli, you can use `//> using scala 3.nightly` to grab the latest one. +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. ## Minimized code From 3eca0a52ae2b1a50f3c747a968e61d47b58cfca2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Koz=C5=82owski?= Date: Thu, 15 May 2025 13:44:03 +0200 Subject: [PATCH 4/4] Update bug.md Co-authored-by: Piotr Chabelski --- .github/ISSUE_TEMPLATE/bug.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 1f523fca796e..8feba58c44d7 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -21,7 +21,8 @@ This code should be self contained, compilable (with possible failures) and as s Ideally, we should be able to just copy this code to a file and run `scalac` (and maybe `scala`) to reproduce the issue. -If the code has external dependencies, please provide the `scala-cli` directives that describe them. +If the code has external dependencies, please provide the Scala CLI directives (or SBT/other build tool configuration) that describe them. +Also note that it's easier and faster for the maintenance team to address issues minimised to reproduce bugs without external dependencies. It's most convenient to also include `using` directives for the Scala version that demonstrates the problem, any compiler command-line options, as well as dependencies. An example is provided.