Skip to content

Commit

Permalink
Update plugin contribution guidelines
Browse files Browse the repository at this point in the history
Signed-off-by: davidmirror-ops <[email protected]>
  • Loading branch information
davidmirror-ops committed Feb 3, 2025
1 parent 27c9edd commit 81141d1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/community/contribute/contribute_integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
(contribute_integrations)=

## Guidelines to contributing integrations

If you plan to contribute a [plugin](https://docs.flyte.org/en/latest/flytesnacks/integrations/index.html) or [Agent](https://docs.flyte.org/en/latest/user_guide/flyte_agents/index.html#flyte-agents-guide), first of all , thank you!

To better support the lifecycle of maintaining an integration, we ask you to follow these guidelines:

- Submit the code to the `community/plugins` folder
- Explicitly mark plugins as community-maintained in the import via `import flytekitplugins.contrib.x`
- Let the `flyte-bot` user have the `Sole Owner` role for your package in `pypi`. This ensures that new releases for your integration follow the `flytekit` release process.

1 change: 1 addition & 0 deletions docs/community/contribute/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,6 @@ For feedback at any point in the contribution process, feel free to reach out to
:hidden:

Contributing code <contribute_code>
Contributing integrations <contribute_integrations>
Contributing docs <contribute_docs>
Contributing tutorials or integrations examples <contribute_examples>

0 comments on commit 81141d1

Please sign in to comment.