first draft of CONTRIBUTING.MD #73
Conversation
|
Would love any advice on format, if information seems clear, if we need all the same sexctions from the dbt-core Contrubting.md file etc. once we get this one done should be just a template for all the others which will make finishing assignment quick so we can take very discerning eyes with this one. |
…McKnight-42/contributing
There was a problem hiding this comment.
@McKnight-42 Thanks for pulling this together! Reading through this has really helped me think through what we want out of these contributing guides, and what ought to live in each adapter plugin vs. in the "core" contributing guide.
I see there's a lot of duplication with the info in the dbt-core contributing doc. I'm thinking we should:
- Update the
dbt-corecontributing doc! A lot of the feedback I left below is relevant there, too - At the top of the
dbt-bigquerycontributing doc, say something like:We recommend that you first read the [core contributing doc](https://github.com/dbt-labs/dbt-core/blob/HEAD/CONTRIBUTING.md), if you haven't already. Almost all of the information there is applicable to contributing here, too!This will prevent us from needing to coordinate updates across many repos
Then, the dbt-bigquery contributing doc can include just the pieces that are different from dbt-core, which I've bolded in my comments below. The big ones are:
- Cloning + installing
dbt-bigquerylocally: usepip install -e . - Running integration tests locally: let's detail the
BIGQUERY_TEST_*env vars that are required - Which docs pages are likely to be impacted by user-facing changes
- Refer to the repo/codebase/package/maintainers as
dbt-bigquerythroughout
…McKnight-42/contributing
…McKnight-42/contributing
…McKnight-42/contributing
…McKnight-42/contributing
…McKnight-42/contributing
* first draft of CONTRIBUTING.MD * second draft at adapter template * moving section in intial setup from dbt-core to adapter repos * added test.env.example * making suggested changes based off kyle's review * minor updates noticed when making first drafts for other adapter repos. * updated test => tests for naming convention * responding to comments on github * continued responses to comments * updates based on review from kyle
resolves #https://github.com/dbt-labs/core-team/issues/33
Description
A first draft of the possible CONTRIUBTING.MD file for the Adapter Repos
Checklist
CHANGELOG.mdand added information about my change to the "dbt-bigquery next" section.