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.
This is a:
Description & motivation
I found, even as an experienced analytics engineer, being new to package development that the developer README for contributors in
integration_tests/README.md
could use some expansion and clarifying to be more welcoming. I've attempted to do this.In doing this I also wanted to clarify the
.env
/profiles.yml
flow to be simpler, as that was my first initial source of confusion. This PR proposes that we:profiles.yml
in the root of the project so it's more discoverable and saves us a step in CI.env/[adapter].env
files, which are run the risk of somebody filling in and committing their credentials, and instead list the env vars needed for each adapter in the expanded README.Checklist