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

Add a CONTRIBUTING.md #292

Open
dataders opened this issue Apr 15, 2024 · 0 comments
Open

Add a CONTRIBUTING.md #292

dataders opened this issue Apr 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request triage

Comments

@dataders
Copy link
Collaborator

dataders commented Apr 15, 2024

Describe the feature

Thanks for flagging @kyleburke-meq! We really need a CONTRIBUTING.md like other dbt repos have (e.g. dbt-snowflake's CONTRIBUTING.md.

What it should include

  • the architecture of the integration_tests/ package, specifically
    • dbt_project.yml and the many if target==<DWH>
    • the tests defined in integration_tests/models/plugins/<DWH>/<DWH>_external.yml (especially YAML anchors)
  • how to write a test case
  • how to run tests and develop locally
    • create local environment variables based on test.env.sample
    • how to make use of integration_tests/profiles.yml
    • what commands to run
  • How GitHub actions CI is set up: specifically:
    • the integration test GitHub Action .github/workflows/integration_tests.yml
    • how pull_request_target works

Who will this benefit?

Anyone who wants to contribute a to this package

@dataders dataders added documentation Improvements or additions to documentation enhancement New feature or request triage labels Apr 15, 2024
@dataders dataders added this to the Improve Documentation milestone Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request triage
Projects
None yet
Development

No branches or pull requests

1 participant