Skip to content

Commit

Permalink
chore: switch bug template to "expected/actual" behavior (aws#9423)
Browse files Browse the repository at this point in the history
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: aws#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*
  • Loading branch information
rix0rrr authored and Curtis Eppel committed Aug 11, 2020
1 parent 6042755 commit 5c0b69b
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,17 @@ description of the bug:
minimal amount of code that causes the bug (if possible) or a reference:
-->




### Error Log
### What did you expect to happen?

<!--
what is the error message you are seeing?
What were you trying to achieve by performing the steps above?
-->

### What actually happened?

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


### Environment
Expand Down

0 comments on commit 5c0b69b

Please sign in to comment.