search

dbt-labs / dbt-meshify

A dbt-core python package that automates the management and creation of dbt groups, contracts, access, and versions.
https://dbt-labs.github.io/dbt-meshify/
Apache License 2.0
110 stars 4 forks source link

Contributing guide #204

Open dbeatty10 opened 6 months ago

dbeatty10 commented 6 months ago

Describe the feature

It would be great to have a CONTRIBUTING.md file that describes what potential contributors would need to install the source code in their local environment, make edits, run tests, and open a PR.

Describe alternatives you've considered

Folks that have used Poetry before could probably intuit what they'd need to do. And folks that haven't could still figure it out by searching the web. But it would definitely be the easiest if a conventional CONTRIBUTING.md file just existed with explicit instructions.

Additional context

N/A

Who will this benefit?

Contributors.

Are you interested in contributing this feature?

Something like the following could be a good start:

Here's the commands I used in a zsh shell on macOS:

  1. Install Poetry

    First, you need to install Poetry on your system if it's not already installed.

    Follow the installation instructions on the Poetry website.

    Check the Poetry version afterwards:

    poetry --version

  2. Clone the GitHub Repository

    git clone https://github.com/dbt-labs/dbt-meshify.git
cd dbt-meshify

  3. Install Dependencies Using Poetry

    poetry install

  4. Activate the Virtual Environment (Optional)

    poetry shell

  5. Do stuff

    This part's all you! Do the edits for your contributions and test them out, etc.

  6. Deactivate the Virtual Environment (Optional)

    If you activated a virtual environment, you'll want to deactivate it when you're all done:

    exit
dave-connors-3 commented 6 months ago

thanks so much @dbeatty10 -- looks like you've got a great start :) we'd welcome a PR!