docs: updating readme with guides for how to generate tests #116
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
…on and guides for how to generate tests
README.md
Outdated
|
|
||
| ## How Do Assertions work? | ||
|
|
||
| Once you've started generating tests, you might want to more quickly determine if your test succeeded or failed, this is where the _Assert Inputs_ fields come in. Assert Inputs are descriptions of screens which are used to evaluate the test generated. When assertions are provided, the LLM will determine if the assertion matches what is on the screen for each assertion provided against every screen visited. These assertions can describe the entire screen (e.g. login screen) or describe an element on the screen (e.g. page with checkout button). These assertions are _not_ used to generate test steps, any intent needed to drive the test generation must be included in the _Test Goal_ field. Below you can see examples of assertions and an example output. |
There was a problem hiding this comment.
This is a single line with 758 characters 😅 Would it be possible to break it down into 80 character chunks? Last time I checked with the team, that seemed like that preferred line length, especially when you try to place windows side by side. Easier to view them inside editors that don't have word-wrap enabled. Also easier to review any changes made in the future!
PS: This is true for some of the other lines above as well 🙏
There was a problem hiding this comment.
Yes! I can do that!
Co-authored-by: Alex Plischke <alex.plischke@saucelabs.com>
Co-authored-by: Alex Plischke <alex.plischke@saucelabs.com>
Co-authored-by: Alex Plischke <alex.plischke@saucelabs.com>
alexplischke
approved these changes
Sep 18, 2024
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.
Guides for how to iterate on prompt and how to write assertions
Also included explicit instructions on how to open the extension.
Description