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

Improve developer README #163

Merged
merged 8 commits into from
Mar 18, 2024
Merged

Improve developer README #163

merged 8 commits into from
Mar 18, 2024

Conversation

gwenwindflower
Copy link
Contributor

@gwenwindflower gwenwindflower commented Mar 5, 2024

This is a:

  • documentation update
  • bug fix with no breaking changes
  • new functionality
  • a breaking change

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:

  • store the CI profiles.yml in the root of the project so it's more discoverable and saves us a step in CI
  • get rid of the .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

  • [n/a] This code is associated with an issue which has been triaged and accepted for development.
  • I have verified that these changes work locally
  • I have updated the README.md (if applicable)
  • [n/a] I have added tests & descriptions to my models (and macros if applicable)
  • I have added an entry to CHANGELOG.md

@gwenwindflower gwenwindflower marked this pull request as ready for review March 5, 2024 20:43
Copy link
Contributor

@joellabes joellabes left a comment

Choose a reason for hiding this comment

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

Approved at a vibes level as opposed to a line-by-line review of the code! I like your plan and justification, and believe in your implementation

integration_tests/README.md Outdated Show resolved Hide resolved
@gwenwindflower
Copy link
Contributor Author

Approved at a vibes level as opposed to a line-by-line review of the code! I like your plan and justification, and believe in your implementation

ty 💗 -- i really wish the markdown had already been auto-linted/formatted as it makes it hard to see exactly what the intentional changes were, as opposed to all the formatting that was automatically applied by Prettier updating the markdown, but now it will be clean moving forward (everybody using VSCode will have the same auto-formatting/linting of the Markdown as this, so should be pretty universal).

i'll add some details re make installation and get this in. 🙏🏻

@gwenwindflower gwenwindflower merged commit c4d1c46 into main Mar 18, 2024
1 check passed
@gwenwindflower gwenwindflower deleted the feat/improve-dev-readme branch March 18, 2024 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants