Skip to content

Commit 406e556

Browse files
authored
chore: switch bug template to "expected/actual" behavior (#9423)
Bug reports typically result from a distinction between a user's mental model and actual behavior. To bring this to the front and center, I like the phrasing: * Tell me what you expected to happen * Tell me what actually happened More than the current: * Paste code * See error The new phrasing subsumes the old one (what actually happened? I got an error) while also allowing to catch more bug-like scenarios. Hopefully it will prevent incomplete reports like this: #9270 where the user pasted in the code, didn't get an error so didn't fill out the "error" section, and didn't really state what they expected or saw happen. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent b1b9d23 commit 406e556

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

.github/ISSUE_TEMPLATE/bug.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,17 @@ description of the bug:
1818
minimal amount of code that causes the bug (if possible) or a reference:
1919
-->
2020

21-
22-
23-
24-
### Error Log
21+
### What did you expect to happen?
2522

2623
<!--
27-
what is the error message you are seeing?
24+
What were you trying to achieve by performing the steps above?
2825
-->
2926

27+
### What actually happened?
3028

29+
<!--
30+
What is the unexpected behavior you were seeing? If you got an error, paste it here.
31+
-->
3132

3233

3334
### Environment

0 commit comments

Comments
 (0)