Skip to content

Commit 7dc9798

Browse files
authored
Add template for reporting 'better-error' issues (#18672)
Add a new issue template for reporting unhelpful/confusing error messages. [skip-ci]
2 parents a133b41 + 8a88c78 commit 7dc9798

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed
+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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+
For a good example, see https://github.com/lampepfl/dotty/issues/18657
23+
-->
24+
25+
```Scala
26+
printl("hello, world")
27+
```
28+
29+
## Output Error/Warning message
30+
31+
<!--
32+
Here, please provide the produced error/warning message that is confusing/unhelpful, etc.
33+
34+
for example:
35+
-->
36+
37+
```scala
38+
-- [E006] Not Found Error: ----------------
39+
1 |printl("hello, world")
40+
|^^^^^^
41+
|Not found: printl
42+
1 error found
43+
```
44+
45+
## Why this Error/Warning was not helpful
46+
47+
<!-- For a good example, see https://github.com/lampepfl/dotty/issues/18657 -->
48+
49+
The message was unhelpful because...
50+
51+
## Suggested improvement
52+
53+
<!-- For a good example, see https://github.com/lampepfl/dotty/issues/18657 -->
54+
55+
It could be made more helpful by...

0 commit comments

Comments
 (0)