From 8755e2de3e588dacfcbe6ce7ebe31f9ad578703d Mon Sep 17 00:00:00 2001 From: Owais Kazi Date: Tue, 6 Sep 2022 17:54:45 -0700 Subject: [PATCH 1/3] Added badges for CI in README Signed-off-by: Owais Kazi --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 7764a325..233ac9ee 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ [![codecov](https://codecov.io/gh/opensearch-project/opensearch-sdk-java/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/opensearch-sdk-java) +[![GHA gradle check](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/build.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/build.yml) +[![GHA validate pull request](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/wrapper.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/wrapper.yml) +[![Code Hygiene](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/code-hygiene.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/code-hygiene.yml) # OpenSearch SDK - [Introduction](#introduction) From 2031ab37d8939c5994482708374df157d68bd310 Mon Sep 17 00:00:00 2001 From: Owais Kazi Date: Tue, 6 Sep 2022 17:58:06 -0700 Subject: [PATCH 2/3] Update readme Signed-off-by: Owais Kazi --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 233ac9ee..7fc67e7e 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ # OpenSearch SDK - [Introduction](#introduction) - [Contributing](#contributing) +- [Design](#design) +- [Maintainers](#maintainers) - [Code of Conduct](#code-of-conduct) ## Introduction @@ -16,6 +18,12 @@ Read more about extensibility [here](https://github.com/opensearch-project/OpenS ## Contributing See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md) +## Design +See [DESIGN](DESIGN.md) + +## Maintainers +See [MAINTAINERS](MAINTAINERS.md) + ## Code of Conduct This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. From 6252c87c91bad27d6f48518e665ceab662f0eab8 Mon Sep 17 00:00:00 2001 From: Owais Kazi Date: Wed, 7 Sep 2022 16:12:41 -0700 Subject: [PATCH 3/3] PR comments Signed-off-by: Owais Kazi --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7fc67e7e..8a0899a5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ [![codecov](https://codecov.io/gh/opensearch-project/opensearch-sdk-java/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/opensearch-sdk-java) [![GHA gradle check](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/build.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/build.yml) [![GHA validate pull request](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/wrapper.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/wrapper.yml) -[![Code Hygiene](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/code-hygiene.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/code-hygiene.yml) -# OpenSearch SDK +# OpenSearch SDK for Java - [Introduction](#introduction) - [Contributing](#contributing) +- [Developer Guide](#developer-guide) - [Design](#design) - [Maintainers](#maintainers) - [Code of Conduct](#code-of-conduct) @@ -16,8 +16,10 @@ Opensearch plugins have allowed the extension and ehancements of various core fe Read more about extensibility [here](https://github.com/opensearch-project/OpenSearch/issues/1422) ## Contributing -See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md) +See [CONTRIBUTING](CONTRIBUTING.md) +## Developer Guide +See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md) ## Design See [DESIGN](DESIGN.md)