Update DEVELOPER_GUIDE

Signed-off-by: Jakob Hahn <[email protected]>
opensearch-project · Oct 12, 2023 · 7132051 · 7132051
1 parent 8d6f009
commit 7132051
Showing 1 changed file with 29 additions and 6 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -26,9 +26,9 @@ Fork [opensearch-project/opensearch-go](https://github.com/opensearch-project/op
 
 ### Install Prerequisites
 
-#### Go 1.11
+#### Go 1.15
 
-OpenSearch Go Client builds using [Go](https://golang.org/doc/install) 1.11 at a minimum.
+OpenSearch Go Client builds using [Go](https://golang.org/doc/install) 1.15 at a minimum.
 
 #### Docker
 
@@ -38,7 +38,7 @@ OpenSearch Go Client builds using [Go](https://golang.org/doc/install) 1.11 at a
 
 To build the project on Windows, use [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install), the compatibility layer for running Linux applications.
 
-Install ```make```
+Install `make`
 ```
 sudo apt install make
 ```
@@ -64,11 +64,10 @@ In order to test opensearch-go client, you need a running OpenSearch cluster. Yo
 
 ### Composing an OpenSearch Docker Container
 
-Ensure that Docker is installed on your local machine. You can check by running `docker --version`. Next, navigate to your local OpenSearch repository where the docker-compose.yaml file is stored. Run the following command to build the docker container. 
+Ensure that Docker is installed on your local machine. You can check by running `docker --version`. Next, navigate to your local opensearch-go repository. Run the following command to build and start the OpenSearch docker container. 
 
 ```
-cd opensearch/.ci/opensearch
-docker-compose -f docker-compose.yml up
+make cluster.build cluster.start
 ```
 
 This command will start the OpenSearch container using the `docker-compose.yaml` configuration file. During the build process, the necessary dependencies and files will be downloaded, which may take some time depending on your internet connection and system resources.
@@ -104,6 +103,30 @@ To check the markdown files, run the following command:
 make lint.markdown
 ```
 
+### Golang lint
+
+To check all golang files, run the following command:
+
+```
+make linters
+```
+
+## Coverage
+
+To get the repository test coverage, run the following command:
+
+For the results to be display in your terminal:
+
+```
+make coverage
+```
+
+For the results to be display in your browser:
+
+```
+make coverage-html
+```
+
 ## Use an Editor
 
 ### GoLand