From 01d2e0c8a79a79d558ea124a9d9c50602908ace6 Mon Sep 17 00:00:00 2001
From: Yulong Ruan <yruan@alpha-sense.com>
Date: Mon, 19 Dec 2022 09:07:11 +0800
Subject: [PATCH] doc: update developer guide

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>
---
 DEVELOPER_GUIDE.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
index 2b0b7f6c..89fc29f5 100644
--- a/DEVELOPER_GUIDE.md
+++ b/DEVELOPER_GUIDE.md
@@ -1 +1,47 @@
 # Developer Guide
+
+## Prerequisites
+To work on OpenSearch-Dashboards(OSD) plugins, you must have OpenSearch and OpenSearch-Dashboards running.
+1. Follow this [link](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) to setup OpenSearch, you can easily get OpenSearch up and running [with Docker](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/docker/)
+2. You also need to run OSD dev server, check this [link](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) to setup local development environment
+
+## Setup
+1. Fork this repository
+2. Change working directory to OSD `/plugins` folder: `cd OpenSearch-Dashboards/plugins`
+3. Clone this repo to plugins folder, `git clone git@github.com:<your-github-username>/ml-commons-dashboards.git ./`
+
+## Install and Run
+```bash
+# install dependencies in OpenSearch-Dashboards/plugins/ml-commons-dashboards
+cd ml-commons-dashboards
+yarn osd bootstrap
+
+# Go to OSD project root and run bootstrap to make sure all deps are installed
+yarn osd bootrap
+
+# start OSD dev server
+yarn start
+```
+If everything went well, OSD will be available on `http://localhost:5601/`
+
+## Unit Test
+In `plugins/ml-commons-dashboards` folder
+```bash
+# run tests
+yarn test:jest
+
+# or in watch mode
+yarn test:jest --watch
+```
+NOTE: Before creating a pull request, please make sure all tests are passed. You’re also encouraged to write tests to cover the code changes you made.
+
+## Release
+
+### Tagging & Versioning
+
+## Project Conventions
+
+### Conventional Commit
+
+### Rebase vs Merge
+