Skip to content

Improve issue templates #13970

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
Nov 17, 2021
Merged

Improve issue templates #13970

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: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ If you're not sure what version you're using, run `print scalaVersion` from sbt

## Minimized code

<!--
This code should be self contained, compilable (with possible failures) and as small as possible.

Ideally, we should be able to just copy this code in a file and run `scalac` (and maybe `scala`) to reproduce the issue.
Copy link
Contributor

Choose a reason for hiding this comment

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

How about also asking for providing the exact command used to run the code? Some bugs are reproducible only with specific compiler flags.
Alternatively maybe we could encourage people to provide reproductions with scala-cli? From my experience (and as I'm dealing with the responsibilities of the issue tsar now) this is really convenient. It allows you to specify all compiler options, scala version java version and others in a single file together with your code. Then we could potentially even automate checking reproducibility of reported issues

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The immediate goal to avoid issues with partial code snippets that cannot be reasoned about. We can always improve it later and add a complete guide.

Not sure if scala-cli would be that helpful right now. What need is tests that can easily be placed in the tests of the compiler. At some point we could enhance our testing framework to understand the scala-cli directives but it seems a bit early.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm quite convinced it would be helpful but of course this is not something we can't live without right now

-->

```Scala
println("hello, world")
```
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/crash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ If you're not sure what version you're using, run `print scalaVersion` from sbt

## Minimized code

<!--
This code should be self contained, compilable (with possible failures) and as small as possible.

Ideally, we should be able to just copy this code in a file and run `scalac` (and maybe `scala`) to reproduce the issue.
-->

```Scala
println("hello, world")
```
Expand Down
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/syntax-highlight.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
name: Syntax highlighting
about: Please create a syntax highlighting issue here https://github.com/scala/vscode-scala-syntax/issues
about: ''
title: ''
labels: ''
assignees: ''

---

Please create a syntax highlighting issue here: [scala/vscode-scala-syntax](https://github.com/scala/vscode-scala-syntax/issues).
Please create a syntax highlighting issue here
* VS Code / GitHub: https://github.com/scala/vscode-scala-syntax/issues
* IntelliJ: https://youtrack.jetbrains.com/issues/SCL?q=tag:%20%7BScala%203%7D%20tag:%20%7BSyntax%20Highlighting%7D
* highlight.js: https://github.com/highlightjs/highlight.js/issues