Document open-source contribution process

dataform-co / dataform

Dataform is a framework for managing SQL based data operations in BigQuery

https://cloud.google.com/dataform/docs

Apache License 2.0

835 stars 161 forks source link

Document open-source contribution process #364

Closed BenBirt closed 4 years ago

BenBirt commented 5 years ago

We should add some stuff to contributors.md. Something like:

when opening a PR, feel free to immediately request a review, probably from @BenBirt or @lewish
one reviewer is fine, add two or more though if you want to get something in faster / want more eyes reviewing
after resolving a round of PR comments, hit the "re-request review" button
once the PR is approved & you have resolved any final comments, ping your reviewer (probably on Slack? or Intercom?) asking for them to run the integration tests & merge the PR if they pass

Ekrekr commented 4 years ago

Requirement for env.yaml and how to access should be added.

Download and install GCloud.
$ gcloud init, log in.
$ gcloud config set project tada-analytics
$ gcloud auth login
$ ./scripts/decode_credentials

Ekrekr commented 4 years ago

Partially fixed in PR #523

faiyaz26 commented 4 years ago

@Ekrekr the commands you provided are not really helpful for the open source developers it is more of dataform-co thing.

Ekrekr commented 4 years ago

@faiyaz26 Ah I see, it's been changed again in PR #537 with the documentation rebase, but the commands haven't changed much. Should there be more info on developing packages do you think?