diff --git a/CHANGELOG.md b/CHANGELOG.md index 818e7558..0758c9b2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -71,7 +71,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Fixes `cargo make test` failing out of the box ([#117](https://github.com/opensearch-project/opensearch-rs/pull/117)) - Fixes f64 comparison in `yaml_test_runner` to use numeric-based comparison instead of string-based ([#150](https://github.com/opensearch-project/opensearch-rs/pull/150)) - Fixes YAML spec tests by adding u64 (unsigned long) support ([#167](https://github.com/opensearch-project/opensearch-rs/pull/167)) - +- Fixes `DEVELOPER_GUIDE.md` to include complete information about setting up ([#194](https://github.com/opensearch-project/opensearch-rs/pull/194)) [Unreleased]: https://github.com/opensearch-project/opensearch-rs/compare/v2.2.0...HEAD [2.2.0]: https://github.com/opensearch-project/opensearch-rs/compare/v2.1.0...v2.2.0 [2.1.0]: https://github.com/opensearch-project/opensearch-rs/compare/v2.0.0...v2.1.0 \ No newline at end of file diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 9a24f270..5f614b08 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -47,6 +47,20 @@ The following information will help in getting up and running. cargo install --force cargo-make ``` +- [**Packages**]() + + Use your preferred package manager to install the following packages: + + Linux + - `build-essential` + - `pkg-config` + - `libssl-dev` + + Example using apt: + ```sh + sudo apt install build-essential pkg-config libssl-dev + ``` + - [**Docker**](https://www.docker.com/) Docker is used to start instances of OpenSearch required for integration tests using [OpenSearch docker images](https://hub.docker.com/r/opensearchproject/opensearch). @@ -58,13 +72,13 @@ The following information will help in getting up and running. Run unit tests. ```sh -cargo test +cargo make test ``` To include optional features, such as AWS auth use the following. ```sh -cargo test --features "aws-auth" +cargo make test --features "aws-auth" ``` ### Cargo Make