Skip to content

Commit

Permalink
fixing minor comments to PR
Browse files Browse the repository at this point in the history
Signed-off-by: Amitai Stern <123amitai@gmail.com>
  • Loading branch information
AmiStrn committed Jun 10, 2024
1 parent e3fe8bf commit 254ac97
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONVENTIONS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [Plugin Location](#plugin-location)
- [Creating New Plugins](#creating-new-plugins)
- [Plugin Naming Conventions](#plugin-naming-conventions)
- [GitHub](#github)
- [OpenSearch Plugins](#opensearch-plugins)
Expand All @@ -16,11 +16,11 @@
- [Identifiers](#identifiers)
- [Variables](#variables)

## Plugin Location
## Creating New Plugins

- Most plugins should start in a repository 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 ported 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. In any case, it is recommended to start outside the project.
- 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

Expand Down

0 comments on commit 254ac97

Please sign in to comment.