Document how to contribute to this repo

[dbeatty10]

This should be solved with a CONTRIBUTING.md file.

Desirable sections

• How to run integration tests locally
• How to bump to a more recent version of a submodule

How to run integration tests locally

Update all submodules after checkout

# clone via SSH
git clone [email protected]:dbt-labs/spark-utils.git
# or for HTTPS
# git clone https://github.com/dbt-labs/spark-utils.git

# Update all submodules
git submodule update --init --recursive

TODO: more info here

To bump to a more recent version of a submodule

For example, dbt-utils 0.8.6:

# Update all submodules
git submodule update --init --recursive

cd dbt-utils
git fetch origin
git checkout 0.8.6
cd ..

git status ./

# Output should show: modified: dbt-utils (new commits)

git diff dbt-utils

# Output should show:
# -Subproject commit eb1ec81c7bc58c3fbcd2cbcf4216b276ccd893ba
# +Subproject commit ac072a3c4b78d43a1c013e7de8b8fa6e290b544e

# Time to commit this update!
git add dbt-utils
git commit -m "Updated dbt-utils submodule"
git push

[tfayyaz]

@dbeatty10 Is this something you are working on and if not I can see if I can contribute towards this with some guidance.

[dbeatty10]

@tfayyaz I'm working on an initial version based largely on this.

Would love to collaborate with you on this!

One way we could do this:

1. I could push my branch and open up a draft PR
2. Then you could create your branch off of that so we can avoid accidental toe-stepping
3. Lastly, we could either merge back into my branch, or just create the final PR from your branch instead.

I'll update this thread when I've pushed that up.

[tfayyaz]

@dbeatty10 thanks for getting back on this and I will wait to hear back once you have added the initial draft.

Thanks