Skip to content

chore: add instructions on howto test specialized environments #3009

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

Merged
merged 7 commits into from
Oct 27, 2021

Conversation

nbbeeken
Copy link
Contributor

@nbbeeken nbbeeken commented Oct 18, 2021

Description

What is changing?

Adding some notes on how to test special environments.

What is the motivation for this change?

Adding documentation for environment variables is good to help figure out the intent. There is a risk of this document falling out of sync with reality if we don't maintain it, but having our intention documented now is helpful when someone comes back to look at how things work.

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

@nbbeeken nbbeeken marked this pull request as ready for review October 19, 2021 18:02
@nbbeeken nbbeeken requested review from dariakp and durran October 19, 2021 18:02
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.

Just a few grammar-related notes and some clarifications. Otherwise looks great, thank you very much for putting this together!

@dariakp dariakp changed the base branch from 4.1 to main October 26, 2021 20:45
@nbbeeken nbbeeken requested a review from dariakp October 27, 2021 14:53
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.

Just a couple minor things, otherwise I think we're good to go here

@dariakp dariakp added the Team Review Needs review from team label Oct 27, 2021
Copy link
Member

@durran durran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one nit.

Co-authored-by: Durran Jordan <[email protected]>
Co-authored-by: Daria Pardue <[email protected]>
@nbbeeken nbbeeken requested review from durran and dariakp October 27, 2021 15:59
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.

LGTM, tyvm

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
Development

Successfully merging this pull request may close these issues.

3 participants