-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add template for reporting 'better-error' issues
- Loading branch information
1 parent
090710a
commit 8a88c78
Showing
1 changed file
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
name: "\U0001F615 Error/Warning message report" | ||
about: Report an error/warning message that was confusing/unhelpful | ||
title: '' | ||
labels: itype:enhancement, area:reporting, better-errors, stat:needs triage | ||
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). | ||
|
||
## Minimized example | ||
|
||
<!-- | ||
This code should be self-contained, reproducible (i.e. produces the expected error/warning message) 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. | ||
For a good example, see https://github.com/lampepfl/dotty/issues/18657 | ||
--> | ||
|
||
```Scala | ||
printl("hello, world") | ||
``` | ||
|
||
## Output Error/Warning message | ||
|
||
<!-- | ||
Here, please provide the produced error/warning message that is confusing/unhelpful, etc. | ||
for example: | ||
--> | ||
|
||
```scala | ||
-- [E006] Not Found Error: ---------------- | ||
1 |printl("hello, world") | ||
|^^^^^^ | ||
|Not found: printl | ||
1 error found | ||
``` | ||
|
||
## Why this Error/Warning was not helpful | ||
|
||
<!-- For a good example, see https://github.com/lampepfl/dotty/issues/18657 --> | ||
|
||
The message was unhelpful because... | ||
|
||
## Suggested improvement | ||
|
||
<!-- For a good example, see https://github.com/lampepfl/dotty/issues/18657 --> | ||
|
||
It could be made more helpful by... |