-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
Improve issue templates #13970
Conversation
fab5f92
to
78f3738
Compare
<!-- | ||
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. |
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.
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
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.
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.
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.
I'm quite convinced it would be helpful but of course this is not something we can't live without right now
<!-- | ||
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. |
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.
I'm quite convinced it would be helpful but of course this is not something we can't live without right now
@prolativ please build on top of this to add |
No description provided.