From 2020d19061d52d9fb70892bf60d88a685175da58 Mon Sep 17 00:00:00 2001 From: Felix Wang Date: Tue, 9 Nov 2021 22:44:38 +0000 Subject: [PATCH] GitBook: [#1] Plugin standards documentation Signed-off-by: Felix Wang --- docs/getting-started/third-party-integrations.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/third-party-integrations.md b/docs/getting-started/third-party-integrations.md index 532d86546f..54cd089332 100644 --- a/docs/getting-started/third-party-integrations.md +++ b/docs/getting-started/third-party-integrations.md @@ -1,6 +1,6 @@ # Third party integrations -We integrate with a wide set of tools and technologies so you can make Feast work in your existing stack. Many of these integrations are maintained as plugins to the main Feast repo. +We integrate with a wide set of tools and technologies so you can make Feast work in your existing stack. Many of these integrations are maintained as plugins to the main Feast repo. {% hint style="info" %} Don't see your offline store or online store of choice here? Check our our guides to make a custom one! @@ -56,3 +56,17 @@ Don't see your offline store or online store of choice here? Check our our guide +## Standards + +In order for a plugin integration to be highlighted on this page, it must meet the following requirements: + +1. The plugin must have tests. Ideally it would use the Feast universal tests (see this [guide](broken-reference) for an example), but custom tests are fine. +2. The plugin must have some basic documentation on how it should be used. +3. The author must work with a maintainer to pass a basic code review (e.g. to ensure that the implementation roughly matches the core Feast implementations). + +In order for a plugin integration to be merged into the main Feast repo, it must meet the following requirements: + +1. The PR must pass all integration tests. The universal tests (tests specifically designed for custom integrations) must be updated to test the integration. +2. There is documentation and a tutorial on how to use the integration. +3. The author (or someone else) agrees to take ownership of all the files, and maintain those files going forward. +4. If the plugin is being contributed by an organization, and not an individual, the organization should provide the infrastructure (or credits) for integration tests.