Skip to content

Commit e41d710

Browse files
authored
Merge pull request #3 from codehag/issue-template
Issue template for suggesting better error messages
2 parents 49e5f24 + 6d14457 commit e41d710

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

ISSUE_TEMPLATE.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!-- This template is intended to help with bad error message reports. -->
2+
<!-- Feel free to file an issue in whatever manner you'd like, with or without this template. -->
3+
4+
**What is the code triggering the message?**
5+
6+
```js
7+
// Your code
8+
```
9+
10+
**What went wrong in the code? What is the system trying to tell you?**
11+
12+
<!-- Note: If you haven't debugged what's wrong with your program yet, please seek help elsewhere, e.g., Stack Overflow. -->
13+
<!-- The purpose of this repository is to improve the wording of error messages for well-understood errors. -->
14+
15+
**What error message do you see?**
16+
17+
<!-- Substitute with your error -->
18+
`TypeError: You are wrong`
19+
20+
**Which JavaScript environment produced this error?**
21+
22+
<!-- e.g., browser version, Node.js version, Babel/TypeScript version (if the error happened during compilation), etc. which produced the error -->
23+
24+
<!-- If possible, include additional error messages here from other JS environments as well -->
25+
26+
**What error message would you like to see?**
27+
28+
<!-- Substitute with the desired error message -->
29+
`TypeError: You put this before that, but that should go before this`
30+
31+
**Do you agree to license your suggested error message under [an MIT-style license](https://github.com/codehag/js-better-errors/blob/master/LICENSE)?**
32+
33+
Yes

0 commit comments

Comments
 (0)