From c8a7c6d134fff68e59dd8cc191e9a2fdc1d0937a Mon Sep 17 00:00:00 2001 From: nacharya1 <41800911+nacharya1@users.noreply.github.com> Date: Mon, 4 Sep 2023 12:55:35 -0700 Subject: [PATCH] Update CONTRIBUTING.md (#2503) ### Motivation and Context ### Description ### Contribution Checklist - [x] The code builds clean without any errors or warnings - [x] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [x] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone :smile: --------- Co-authored-by: Devis Lucato Co-authored-by: Shawn Callegari <36091529+shawncal@users.noreply.github.com> Co-authored-by: Harleen Thind <39630244+hathind-ms@users.noreply.github.com> --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77d5cf256d..14cbb9be65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,6 +111,32 @@ The scripts below are used to build, test, and lint within the project. - Build/Test: `yarn build` - Linting (auto-fix): `yarn lint:fix` +### Adding Plugins and Memory Connectors + +When considering contributions to plugins and memory connectors for Semantic +Kernel, please note the following guidelines: + +#### Plugins + +We appreciate your interest in extending Semantic Kernel's functionality through +plugins. However, we want to clarify our approach to hosting plugins within our +GitHub repository. To maintain a clean and manageable codebase, we will not be +hosting plugins directly in the Semantic Kernel GitHub repository. +Instead, we encourage contributors to host their plugin code in separate +repositories under their own GitHub accounts or organization. You can then +provide a link to your plugin repository in the relevant discussions, issues, +or documentation within the Semantic Kernel repository. This approach ensures +that each plugin can be maintained independently and allows for easier tracking +of updates and issues specific to each plugin. + +#### Memory Connectors + +For memory connectors, while we won't be directly adding hosting for them within +the Semantic Kernel repository, we highly recommend building memory connectors +as separate plugins. Memory connectors play a crucial role in interfacing with +external memory systems, and treating them as plugins enhances modularity and +maintainability. + ### PR - CI Process The continuous integration (CI) system will automatically perform the required