search

PrefectHQ / prefect-recipes

Snippets and templates representing common Customer Success patterns
https://PrefectHQ.github.io/prefect-recipes/
Apache License 2.0
238 stars 29 forks source link

Update contribution information #191

Closed serinamarie closed 1 year ago

serinamarie commented 1 year ago

Description

Uses our new contribution page in the docs to provide details on how to contribute

https://docs.prefect.io/recipes/contribute-recipes/

ahuang11 commented 1 year ago

Looks good to me! My only suggestion is if https://docs.prefect.io/recipes/contribute-recipes/ also has these commands to help lower the friction / activation energy for the user to contribute. Also, I wonder if they need to first fork the repo?

git clone git@github.com:PrefectHQ/prefect-recipes.git
git branch feat/recipe-name
git checkout feat/recipe-name
serinamarie commented 1 year ago

Looks good to me! My only suggestion is if https://docs.prefect.io/recipes/contribute-recipes/ also has these commands to help lower the friction / activation energy for the user to contribute. Also, I wonder if they need to first fork the repo?

git clone git@github.com:PrefectHQ/prefect-recipes.git
git branch feat/recipe-name
git checkout feat/recipe-name

That's a good point. While the documentation doesn't have these commands laid out, I think it might be best to keep them here as well.

ahuang11 commented 1 year ago

Maybe a PR to add these commands to the Prefect docs would help

serinamarie commented 1 year ago

Maybe a PR to add these commands to the Prefect docs would help

They could add the commands to this section: https://docs.prefect.io/recipes/contribute-recipes/#steps-to-adding-your-recipe

serinamarie commented 1 year ago

Maybe a PR to add these commands to the Prefect docs would help

This was completed here: https://github.com/PrefectHQ/prefect/pull/8283