From 81141d1299fef910fde2b3d0af5143d8d1af46ba Mon Sep 17 00:00:00 2001 From: davidmirror-ops Date: Mon, 3 Feb 2025 12:30:12 -0500 Subject: [PATCH] Update plugin contribution guidelines Signed-off-by: davidmirror-ops --- docs/community/contribute/contribute_integrations.md | 12 ++++++++++++ docs/community/contribute/index.rst | 1 + 2 files changed, 13 insertions(+) create mode 100644 docs/community/contribute/contribute_integrations.md diff --git a/docs/community/contribute/contribute_integrations.md b/docs/community/contribute/contribute_integrations.md new file mode 100644 index 0000000000..3259952fac --- /dev/null +++ b/docs/community/contribute/contribute_integrations.md @@ -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. + diff --git a/docs/community/contribute/index.rst b/docs/community/contribute/index.rst index eb13f5d73f..9d33f4b1ce 100644 --- a/docs/community/contribute/index.rst +++ b/docs/community/contribute/index.rst @@ -60,5 +60,6 @@ For feedback at any point in the contribution process, feel free to reach out to :hidden: Contributing code + Contributing integrations Contributing docs Contributing tutorials or integrations examples \ No newline at end of file