Back to Prefect

Contribute to integrations

docs/contribute/contribute-integrations.mdx

3.6.30.dev31.7 KB
Original Source

Prefect welcomes contributions to existing integrations.

<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>

Contributing to existing integrations

All integrations are hosted in the Prefect GitHub repository under src/integrations.

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 sync ``` </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>