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

Contributing instructions #1723

Merged
merged 11 commits into from
Aug 1, 2022
Merged

Contributing instructions #1723

merged 11 commits into from
Aug 1, 2022

Conversation

dbeatty10
Copy link
Contributor

Resolves #1721, unlocks #1341

Overview

This is an initial set of instructions for doing development on this repository. It also includes a brief explanation how it relates to Hubcap and dbt deps (from dbt Core).

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.

A typo and a couple of things that could be clearer, but otherwise looking good!


You can set the `DBT_PACKAGE_HUB_URL` environment variable to specify where `dbt deps` should look to resolve dependencies [listed in `packages.yml`](https://docs.getdbt.com/docs/building-a-dbt-project/package-management#how-do-i-add-a-package-to-my-project):
```shell
export DBT_PACKAGE_HUB_URL=http://localhost:4567/
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps instructions on how to delete this afterwards as well? Or at least a reminder to delete it afterwards

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Very good point! Committed an update to incorporate this feedback.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated

### Installing Ruby for Mac

[https://antran.app/2021/m1_mac_part2/](https://antran.app/2021/m1_mac_part2/)
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this link for? Do I only need to read it if I have an M1 Mac? Does it replace the instructions below if I'm on an M1? Is it where the below instructions came from?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Committed an update to incorporate this feedback.

CONTRIBUTING.md Show resolved Hide resolved
@dbeatty10 dbeatty10 requested a review from joellabes July 29, 2022 01:05
@dbeatty10 dbeatty10 merged commit 8875ab7 into master Aug 1, 2022
@dbeatty10 dbeatty10 deleted the dbeatty/contributing branch August 1, 2022 22:24
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.

Contributing instructions
2 participants