Skip to content
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

Merged
merged 16 commits into from
Dec 1, 2021
Merged

Conversation

ljhaywar
Copy link
Contributor

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

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: <type>(NODE-xxxx)<!>: <description>
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@ljhaywar
Copy link
Contributor Author

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.

@ljhaywar ljhaywar self-assigned this Nov 18, 2021
@durran durran self-assigned this Nov 18, 2021
@durran durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Nov 18, 2021
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
test/readme.md Outdated Show resolved Hide resolved
@ljhaywar
Copy link
Contributor Author

@durran Thanks for the feedback! I've made updates. Can you take another look at your convenience?

@durran durran added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Nov 22, 2021
Copy link
Contributor

@nbbeeken nbbeeken left a 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 😃

Copy link
Contributor

@dariakp dariakp left a 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!

Copy link
Contributor

@baileympearson baileympearson left a 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! 😃

@durran durran merged commit c2a10b4 into main Dec 1, 2021
@durran durran deleted the NODE-3753/update-testing-docs branch December 1, 2021 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
5 participants