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.

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

Conversation

nicolasstucki
Copy link
Contributor

No description provided.

@nicolasstucki nicolasstucki force-pushed the improve-issue-templates branch from fab5f92 to 78f3738 Compare November 17, 2021 09:45
<!--
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

<!--
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.

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

@nicolasstucki nicolasstucki merged commit 9a855a5 into scala:master Nov 17, 2021
@nicolasstucki nicolasstucki deleted the improve-issue-templates branch November 17, 2021 13:06
@nicolasstucki
Copy link
Contributor Author

@prolativ please build on top of this to add scala-cli instructions when you have some time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants