Skip to content

Commit c8a7c6d

Browse files
nacharya1dlucshawncalhathind-ms
authored
Update CONTRIBUTING.md (microsoft#2503)
### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? Updating to support questions from community members on plugin hosting 3. What problem does it solve? Provides guidance on SK's repo and plugin 5. What scenario does it contribute to? Plugin and memory plugins created by the community 7. If it fixes an open issue, please link to the issue here. --> ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [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 😄 --------- Co-authored-by: Devis Lucato <[email protected]> Co-authored-by: Shawn Callegari <[email protected]> Co-authored-by: Harleen Thind <[email protected]>
1 parent 5de1dba commit c8a7c6d

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,32 @@ The scripts below are used to build, test, and lint within the project.
111111
- Build/Test: `yarn build`
112112
- Linting (auto-fix): `yarn lint:fix`
113113

114+
### Adding Plugins and Memory Connectors
115+
116+
When considering contributions to plugins and memory connectors for Semantic
117+
Kernel, please note the following guidelines:
118+
119+
#### Plugins
120+
121+
We appreciate your interest in extending Semantic Kernel's functionality through
122+
plugins. However, we want to clarify our approach to hosting plugins within our
123+
GitHub repository. To maintain a clean and manageable codebase, we will not be
124+
hosting plugins directly in the Semantic Kernel GitHub repository.
125+
Instead, we encourage contributors to host their plugin code in separate
126+
repositories under their own GitHub accounts or organization. You can then
127+
provide a link to your plugin repository in the relevant discussions, issues,
128+
or documentation within the Semantic Kernel repository. This approach ensures
129+
that each plugin can be maintained independently and allows for easier tracking
130+
of updates and issues specific to each plugin.
131+
132+
#### Memory Connectors
133+
134+
For memory connectors, while we won't be directly adding hosting for them within
135+
the Semantic Kernel repository, we highly recommend building memory connectors
136+
as separate plugins. Memory connectors play a crucial role in interfacing with
137+
external memory systems, and treating them as plugins enhances modularity and
138+
maintainability.
139+
114140
### PR - CI Process
115141

116142
The continuous integration (CI) system will automatically perform the required

0 commit comments

Comments
 (0)