add convention for plugin location (relates to #13879) (#233)

* add convention for plugin location (relates to #13879) Signed-off-by: Amitai Stern <[email protected]> * Update CONVENTIONS.md Co-authored-by: Andrew Ross <[email protected]> Signed-off-by: amitai stern <[email protected]> * Update CONVENTIONS.md Co-authored-by: Andrew Ross <[email protected]> Signed-off-by: amitai stern <[email protected]> * added to toc Signed-off-by: Amitai Stern <[email protected]> * fixing minor comments to PR Signed-off-by: Amitai Stern <[email protected]> --------- Signed-off-by: Amitai Stern <[email protected]> Signed-off-by: amitai stern <[email protected]> Co-authored-by: Andrew Ross <[email protected]>
opensearch-project · Jun 17, 2024 · 789b855 · 789b855
1 parent 2a50a99
commit 789b855
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/CONVENTIONS.md b/CONVENTIONS.md
@@ -1,3 +1,4 @@
+- [Creating New Plugins](#creating-new-plugins)
 - [Plugin Naming Conventions](#plugin-naming-conventions)
   - [GitHub](#github)
     - [OpenSearch Plugins](#opensearch-plugins)
@@ -15,6 +16,12 @@
   - [Identifiers](#identifiers)
   - [Variables](#variables)
 
+## Creating New Plugins
+
+- Create plugins in your own personal repo (outside of the opensearch-project). This allows for rapid iteration during initial development without the overhead of being an official part of the project.
+- Plugins can be later moved into the opensearch-project on a case-by-case basis. A formal path for this process is yet to be created.
+- Do not add new plugins to the [plugins folder](https://github.com/opensearch-project/OpenSearch/tree/main/plugins) within the core OpenSearch repository. The maintainers likely do not have domain expertise in your new optional plugin. If you think it should be there anyway, please explain why in the RFC stage.   
+
 ## Plugin Naming Conventions
 
 ### GitHub