-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
revamp integration contributor guide and clean up other sections (#16757
- Loading branch information
Showing
6 changed files
with
306 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,70 @@ | ||
--- | ||
sidebarTitle: Contribute integrations | ||
title: Contribute integrations | ||
sidebarTitle: Contribute to integrations | ||
title: Contribute to integrations | ||
--- | ||
|
||
Prefect welcomes integration contributions. | ||
Create an integration package for community use by following the steps below. | ||
Prefect welcomes contributions to existing integrations. | ||
|
||
## Generate a project | ||
<Tip> | ||
Thinking about making your own integration? Feel free to [create a new discussion](https://github.com/PrefectHQ/prefect/discussions/new?category=ideas) to flesh out your idea with other contributors. | ||
</Tip> | ||
|
||
To help you create an integration, use [this GitHub repository](https://github.com/PrefectHQ/prefect-collection-template#quickstart) to bootstrap an integration project. | ||
The repository uses [Cookiecutter](https://cookiecutter.readthedocs.io/) to generate a project structure. | ||
The template includes tools for testing, linting, docs, and building the package. | ||
## Contributing to existing integrations | ||
|
||
## List your project in the integrations catalog | ||
All integrations are hosted in the [Prefect GitHub repository](https://github.com/PrefectHQ/prefect) under `src/integrations`. | ||
|
||
To list your integration in the Prefect integrations catalog, submit a pull request to the [Prefect GitHub repository](https://github.com/PrefectHQ/prefect). | ||
To contribute to an existing integration, please follow these steps: | ||
|
||
<Steps> | ||
<Step title="Fork the repository 🍴"> | ||
Fork the [Prefect GitHub repository](https://github.com/PrefectHQ/prefect) | ||
</Step> | ||
|
||
<Step title="Clone your fork 👯"> | ||
```bash | ||
git clone https://github.com/your-username/prefect.git | ||
``` | ||
</Step> | ||
|
||
<Step title="Create a new branch 🌲"> | ||
```bash | ||
git checkout -b my-new-branch | ||
``` | ||
</Step> | ||
|
||
<Step title="Set up your environment 📂"> | ||
Move to the integration directory and install the dependencies: | ||
```bash | ||
cd src/integrations/my-integration | ||
uv venv --python 3.12 | ||
source .venv/bin/activate | ||
uv pip install -e ".[dev]" | ||
``` | ||
</Step> | ||
|
||
<Step title="Make your changes 👩🍳"> | ||
Make the necessary changes to the integration code. | ||
</Step> | ||
|
||
<Step title="Add tests 🧪"> | ||
If you're adding new functionality, please add tests. | ||
|
||
You can run the tests with: | ||
```bash | ||
pytest tests | ||
``` | ||
</Step> | ||
|
||
<Step title="Submit your changes 📨"> | ||
```bash | ||
git add . | ||
git commit -m "My new integration" | ||
git push origin my-new-branch | ||
``` | ||
</Step> | ||
|
||
<Step title="Create a pull request ⏰"> | ||
Submit your pull request upstream through the GitHub interface. | ||
</Step> | ||
</Steps> | ||
|
||
Add a file to the `docs/integrations/catalog` directory with details about your integration package. | ||
Use the `TEMPLATE.yaml` file in that folder as a guide. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,14 @@ | ||
To install Prefect with pip, run: | ||
To install Prefect with `pip`, run: | ||
|
||
```bash | ||
<CodeGroup> | ||
|
||
```bash pip | ||
pip install -U prefect | ||
``` | ||
``` | ||
|
||
```bash uv | ||
uv pip install -U prefect | ||
``` | ||
|
||
|
||
</CodeGroup> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.