Skip to content

Commit efde8c5

Browse files
authored
Add guidelines for code contributions (#3976)
A set of guidelines to decide whether a feature should be included in OpenSearch. Signed-off-by: Rabi Panda <adnapibar@gmail.com>
1 parent 1c787e8 commit efde8c5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,16 @@ If you would like to contribute to the documentation, please do so in the [docum
5959

6060
As with other types of contributions, the first step is to [**open an issue on GitHub**](https://github.com/opensearch-project/OpenSearch/issues/new/choose). Opening an issue before you make changes makes sure that someone else isn't already working on that particular problem. It also lets us all work together to find the right approach before you spend a bunch of time on a PR. So again, when in doubt, open an issue.
6161

62+
Additionally, here are a few guidelines to help you decide whether a particular feature should be included in OpenSearch.
63+
64+
**Is your feature important to most users of OpenSearch?**
65+
66+
If you believe that a feature is going to fulfill a need for most users of OpenSearch, then it belongs in OpenSearch. However, we don't want every feature built into the core server. If the feature requires additional permissions or brings in extra dependencies it should instead be included as a module in core.
67+
68+
**Is your feature a common dependency across multiple plugins?**
69+
70+
Does this feature contain functionality that cuts across multiple plugins? If so, this most likely belongs in OpenSearch as a core module or plugin.
71+
6272
Once you've opened an issue, check out our [Developer Guide](./DEVELOPER_GUIDE.md) for instructions on how to get started.
6373

6474
## Developer Certificate of Origin

0 commit comments

Comments
 (0)