chore: switch bug template to "expected/actual" behavior #9423
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
eladb
reviewed
Aug 4, 2020
eladb
pushed a commit
that referenced
this pull request
Aug 10, 2020
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*
curtiseppel
pushed a commit
to curtiseppel/aws-cdk
that referenced
this pull request
Aug 11, 2020
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*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
More than the current:
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