dbt-labs / dbt-adapters

Apache License 2.0
25 stars 35 forks source link

Update contributor guide for `hatch` #251

Closed mikealfare closed 2 months ago

mikealfare commented 3 months ago

resolves #164

Problem

The contributor guide referenced the previous development workflows using pip.

Solution

Update the contributor guide to reference hatch development workflows.

Checklist

github-actions[bot] commented 3 months ago

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

McKnight-42 commented 3 months ago

in the About this document section we talk about how functional tests would require a database connection.

Should we provide an example of setting up for functional testing? or would it make sense to openly suggest using our ci/cd to test functional tests. (maybe thinking too much in a way for outward-facing/new hire setup docs)

McKnight-42 commented 3 months ago

just a nit from looking at link in slack:

the link to the functional tests link in top of Testing section seems to be dead.

McKnight-42 commented 3 months ago

Loving these updates!

mikealfare commented 3 months ago

in the About this document section we talk about how functional tests would require a database connection.

Should we provide an example of setting up for functional testing? or would it make sense to openly suggest using our ci/cd to test functional tests. (maybe thinking too much in a way for outward-facing/new hire setup docs)

Good catch, given we don't have functional tests at the moment, this reference should just be removed and then added back once we figure out how to incorporate the target adapter in the CI workflows.

mikealfare commented 3 months ago

just a nit from looking at link in slack:

the link to the functional tests link in top of Testing section seems to be dead.

Same as above, this reference just needs to be removed. I replaced it with a blurb about the fact that we're working on adding functional testing back in.

McKnight-42 commented 3 months ago

Should we also update a guide for dbt-tests-adapter for local testing as we can use functional testing there? few thoughts of useful context would be like how to reinstall the environment from a local repo to make sure your testing an adapter with most recent updates between the repos

mikealfare commented 2 months ago

in the About this document section we talk about how functional tests would require a database connection.

Should we provide an example of setting up for functional testing? or would it make sense to openly suggest using our ci/cd to test functional tests. (maybe thinking too much in a way for outward-facing/new hire setup docs)

I think we should leave that to the concrete adapter repos. It gets too complicated. I removed it for now, until we come up with a way to easily run functional tests against downstream repos.

mikealfare commented 2 months ago

Should we also update a guide for dbt-tests-adapter for local testing as we can use functional testing there? few thoughts of useful context would be like how to reinstall the environment from a local repo to make sure your testing an adapter with most recent updates between the repos

I updated the guide for this for GitHub updates. Per conversations this week, we may want to expand this to use local directories as well, but I'll leave that for a future PR.