-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(NODE-3753): Update testing readme file #3048
Conversation
Some notes... Benchmark tests explanation - this was very much an educated guess. Is there any more info on those that we can point people to? Using a Pre-Release Version of a Dependent Library. I based the instructions on Daria’s comments in the Jira ticket. I was able to follow the steps, and the tests didn’t blow up, but I wasn’t sure how to verify I was actually using the pre-release version. I left TODOs for explaining what the environment variables represent and how to get their values. If someone wants to take a crack at explaining that, I’m happy to clean up the wording. I left “TODO Special Env Sections” alone. If someone wants to take a crack at those, I’m happy to clean up the wording. |
@durran Thanks for the feedback! I've made updates. Can you take another look at your convenience? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much! this is a great write up 😃
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, thank you so much for the work you did here!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes look good to me (given my limited experience) and they've already proved helpful. Thanks for taking this on! 😃
Description
NODE 3753
What is changing?
Updating the Test readme to have more detailed information about the tests
Is there new documentation needed for these changes?
No
What is the motivation for this change?
The readme was lacking details that newbies need to understand the test infrastructure
Double check the following
npm run check:lint
script<type>(NODE-xxxx)<!>: <description>
Changes are covered by testsNew TODOs have a related JIRA ticket