Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer guide #638

Merged
merged 6 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
- [Developer Guide](#developer-guide)
- [Prerequisites](#prerequisites)
- [Install Docker Image](#install-docker-image)
- [Running Tests](#running-tests)
- [Client Code Generator](#client-code-generator)

# Developer Guide

## Prerequisites

The .NET 6.0 SDK is required:

```
$ dotnet --list-sdks
6.0.xxx
```

## Running Tests

The integration tests will download opensearch and run a local cluster for you. To run the full suite of tests, all you need to do is call the below script.

```
.\build.bat
```

```
build.sh
```

## Client Code Generator

OpenSearch publishes an [OpenAPI specification](https://github.com/opensearch-project/opensearch-api-specification/releases/download/main/opensearch-openapi.yaml) in the [opensearch-api-specification](https://github.com/opensearch-project/opensearch-api-specification) repository, which is used to auto-generate the less interesting parts of the client.

```
./build.sh codegen --branch main
```
or
```
./build.bat codegen --branch main
```
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [OpenSearch.Client](#opensearch-client)
- [Getting Started](#getting-started)
- [Compatibility with OpenSearch](#compatibility-with-opensearch)
- [Developer Guide](#developer-guide)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
- [Copyright](#copyright)
Expand Down Expand Up @@ -55,6 +56,10 @@ See [USER_GUIDE](USER_GUIDE.md) to get started with the .NET client.

See [COMPATIBILITY](COMPATIBILITY.md).

## Developer Guide

See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.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 [[email protected]](mailto:[email protected]) with any additional questions or comments.
Expand Down
Loading