Skip to content

Commit

Permalink
Add template for reporting 'better-error' issues (#18672)
Browse files Browse the repository at this point in the history
Add a new issue template for reporting unhelpful/confusing error
messages.

[skip-ci]
  • Loading branch information
bishabosha committed Oct 10, 2023
2 parents a133b41 + 8a88c78 commit 7dc9798
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/improve-error.md
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...

0 comments on commit 7dc9798

Please sign in to comment.