chore: update language on how to test section #3
Conversation
This file contains hidden or 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
joelpalmer
approved these changes
Jul 28, 2022
Contributor
joelpalmer
left a comment
joelpalmer
left a comment
There was a problem hiding this comment.
I think we discussed this a bit when I originally added it. The audience for the How to Demo section in the Issue is primarily the author or possibly a product person. The audience for the How to Test section in the PR is the Code Reviewers. At least that is how I have understood it.
So, I think your additional wording really makes that distinction clear and states what types of content we would like to see in that section. We have been and will continue to stress the importance of testing beyond the happy path. 👍🏼
Perfect! 🎸
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.
What is the new behavior?
The "How to Test" section is especially important for some PR to describe nuances around manually testing the new feature outside of Production. It is not intended to replace the "How to Demo" part of the issue requirements, but I've noticed that in some cases it's being referred to almost exclusively.
I've kept the section in place but reworded things a bit to re-iterate the importance of How to Demo and how this section should be used to help the PR process rather than serving as a source of truth for requirements.
Feel free to bikeshed the nuances of my language -- this was a very rough first stab 😄
Other information
Does this PR introduce a breaking change? No