Skip to content

Commit 19d884c

Browse files
committed
Add template for reporting 'better-error' issues
1 parent 090710a commit 19d884c

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: "\U0001F615 Error/Warning message report"
3+
about: Report an error/warning message that was confusing/unhelpful
4+
title: ''
5+
labels: itype:enhancement, area:reporting, better-errors, stat:needs triage
6+
assignees: ''
7+
8+
---
9+
10+
## Compiler version
11+
12+
If you're not sure what version you're using, run `print scalaVersion` from sbt
13+
(if you're running scalac manually, use `scalac -version` instead).
14+
15+
## Minimized example
16+
17+
<!--
18+
This code should be self-contained, reproducible (i.e. produces the expected error/warning message) and as small as possible.
19+
20+
Ideally, we should be able to just copy this code in a file and run `scalac` (and maybe `scala`) to reproduce the issue.
21+
-->
22+
23+
```Scala
24+
printl("hello, world")
25+
```
26+
27+
## Output Error/Warning message
28+
29+
<!--
30+
Here, please provide the produced error/warning message that is confusing/unhelpful, etc.
31+
32+
for example:
33+
-->
34+
35+
```scala
36+
-- [E006] Not Found Error: ----------------
37+
1 |printl("hello, world")
38+
|^^^^^^
39+
|Not found: printl
40+
1 error found
41+
```
42+
43+
## Why this Error/Warning was not helpful
44+
45+
The message was unhelpful because...
46+
47+
## Suggested improvement
48+
49+
It could be made more helpful by...

0 commit comments

Comments
 (0)