From d7f7f2052004a13ce09e9bbbc404e79aefcff6df Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 02:23:06 +0530
Subject: [PATCH 01/16] 1st iteration

---
 CONTRIBUTING.md | 297 +++++++++++++++++++++++++-----------------------
 1 file changed, 155 insertions(+), 142 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 54ff60451b..ca6eef6f25 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,147 +1,13 @@
-# How to Contribute
+## Welcome to SigNoz contributing section. Thank you for taking out the time to contribute to this project.
 
-There are primarily 2 areas in which you can contribute in SigNoz
+Sections:
+1. [General Guidelines](#1-general-instructions) 
+2. [How to Contribute](#2-how-to-contribute)
+3. [Develop Frontend](#3-develop-frontend)
+4. [Contribute to Query-Service](#4-contribute-to-query-service)
+5. [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart)
 
-- Frontend ( written in Typescript, React)
-- Backend - ( Query Service - written in Go)
-
-Depending upon your area of expertise & interest, you can chose one or more to contribute. Below are detailed instructions to contribute in each area
-
-> Please note: If you want to work on an issue, please ask the maintainers to assign the issue to you before starting work on it. This would help us understand who is working on an issue and prevent duplicate work. 🙏🏻
-
-> If you just raise a PR, without the corresponding issue being assigned to you - it may not be accepted.
-
-# Develop Frontend
-
-Need to update [https://github.com/SigNoz/signoz/tree/main/frontend](https://github.com/SigNoz/signoz/tree/main/frontend)
-
-### Contribute to Frontend with Docker installation of SigNoz
-
-- `git clone https://github.com/SigNoz/signoz.git && cd signoz`
-- comment out frontend service section at `deploy/docker/clickhouse-setup/docker-compose.yaml#L62`
-- run `cd deploy` to move to deploy directory
-- Install signoz locally without the frontend
-    - Add below configuration to query-service section at `docker/clickhouse-setup/docker-compose.yaml#L38`
-
-    ```docker
-    ports:
-      - "8080:8080"
-    ```
-  - If you are using x86_64 processors (All Intel/AMD processors) run `sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d`
-  - If you are on arm64 processors (Apple M1 Macbooks) run `sudo docker-compose -f docker/clickhouse-setup/docker-compose.arm.yaml up -d`
-- `cd ../frontend` and change baseURL to `http://localhost:8080` in file `src/constants/env.ts`
-- `yarn install`
-- `yarn dev`
-
-> Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh`
-
-### Contribute to Frontend without installing SigNoz backend
-
-If you don't want to install SigNoz backend just for doing frontend development, we can provide you with test environments which you can use as the backend. Please ping us in #contributing channel in our [slack community](https://signoz.io/slack) and we will DM you with `<test environment URL>`
-
-- `git clone https://github.com/SigNoz/signoz.git && cd signoz/frontend`
-- Create a file `.env` with `FRONTEND_API_ENDPOINT=<test environment URL>`
-- `yarn install`
-- `yarn dev`
-
-**_Frontend should now be accessible at `http://localhost:3301/application`_**
-
-# Contribute to Query-Service
-
-Need to update [https://github.com/SigNoz/signoz/tree/main/pkg/query-service](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)
-
-### To run ClickHouse setup (recommended for local development)
-
-- git clone https://github.com/SigNoz/signoz.git
-- run `cd signoz` to move to signoz directory
-- run `sudo make dev-setup` to configure local setup to run query-service
-- comment out frontend service section at `docker/clickhouse-setup/docker-compose.yaml`
-- comment out query-service section at `docker/clickhouse-setup/docker-compose.yaml`
-- add below configuration to clickhouse section at `docker/clickhouse-setup/docker-compose.yaml`
-```docker
-    expose:
-      - 9000
-    ports:
-      - 9001:9000
-```
-
-- run `cd pkg/query-service/` to move to query-service directory
-- Open ./constants/constants.go
-    - Replace ```const RELATIONAL_DATASOURCE_PATH = "/var/lib/signoz/signoz.db"``` \
-        with ```const RELATIONAL_DATASOURCE_PATH = "./signoz.db".```
-
-- Install signoz locally without the frontend and query-service
-  - If you are using x86_64 processors (All Intel/AMD processors) run `sudo make run-x86`
-  - If you are on arm64 processors (Apple M1 Macbooks) run `sudo make run-arm`
-
-#### Run locally
-```console
-ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse go run main.go
-```
-
-> Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh`
-
-**_Query Service should now be available at `http://localhost:8080`_**
-
-> If you want to see how, frontend plays with query service, you can run frontend also in you local env with the baseURL changed to `http://localhost:8080` in file `src/constants/env.ts` as the query-service is now running at port `8080`
-
----
-<!-- Instead of configuring a local setup, you can also use [Gitpod](https://www.gitpod.io/), a VSCode-based Web IDE.
-
-Click the button below. A workspace with all required environments will be created.
-
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/SigNoz/signoz)
-
-> To use it on your forked repo, edit the 'Open in Gitpod' button url to `https://gitpod.io/#https://github.com/<your-github-username>/signoz` -->
-
-# Contribute to SigNoz Helm Chart
-
-Need to update [https://github.com/SigNoz/charts](https://github.com/SigNoz/charts).
-
-### To run helm chart for local development
-
-- run `git clone https://github.com/SigNoz/charts.git` followed by `cd charts`
-- it is recommended to use lightweight kubernetes (k8s) cluster for local development:
-  - [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
-  - [k3d](https://k3d.io/#installation)
-  - [minikube](https://minikube.sigs.k8s.io/docs/start/)
-- create a k8s cluster and make sure `kubectl` points to the locally created k8s cluster
-- run `make dev-install` to install SigNoz chart with `my-release` release name in `platform` namespace.
-- run `kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301` to make SigNoz UI available at [localhost:3301](http://localhost:3301)
-
-**To install HotROD sample app:**
-
-```bash
-curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-install.sh \
-  | HELM_RELEASE=my-release SIGNOZ_NAMESPACE=platform bash
-```
-
-**To load data with HotROD sample app:**
-
-```bash
-kubectl -n sample-application run strzal --image=djbingham/curl \
-  --restart='OnFailure' -i --tty --rm --command -- curl -X POST -F \
-  'locust_count=6' -F 'hatch_rate=2' http://locust-master:8089/swarm
-```
-
-**To stop the load generation:**
-
-```bash
-kubectl -n sample-application run strzal --image=djbingham/curl \
-  --restart='OnFailure' -i --tty --rm --command -- curl \
-  http://locust-master:8089/stop
-```
-
-**To delete HotROD sample app:**
-
-```bash
-curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-delete.sh \
-  | HOTROD_NAMESPACE=sample-application bash
-```
-
----
-
-## General Instructions
+# 1. General Instructions
 
 **Before making any significant changes, please open an issue**. Each issue
 should describe the following:
@@ -188,3 +54,150 @@ e.g. If you are submitting a fix for an issue in frontend - PR name should be pr
 2. Follow [GitHub Flow](https://guides.github.com/introduction/flow/) guidelines for your contribution flows
 
 3. Feel free to ping us on `#contributing` or `#contributing-frontend` on our slack community if you need any help on this :)
+
+
+# 2. How to Contribute
+
+There are primarily 2 areas in which you can contribute in SigNoz
+
+- Frontend ( written in Typescript, React)
+- Backend - ( Query Service - written in Go)
+
+Depending upon your area of expertise & interest, you can chose one or more to contribute. Below are detailed instructions to contribute in each area
+
+> Please note: If you want to work on an issue, please ask the maintainers to assign the issue to you before starting work on it. This would help us understand who is working on an issue and prevent duplicate work. 🙏🏻
+
+> If you just raise a PR, without the corresponding issue being assigned to you - it may not be accepted.
+
+# 3. Develop Frontend
+
+Need to update [https://github.com/SigNoz/signoz/tree/main/frontend](https://github.com/SigNoz/signoz/tree/main/frontend)
+
+### 3.1 Contribute to Frontend with Docker installation of SigNoz
+
+- `git clone https://github.com/SigNoz/signoz.git && cd signoz`
+- comment out frontend service section at `deploy/docker/clickhouse-setup/docker-compose.yaml#L62`
+- run `cd deploy` to move to deploy directory
+- Install signoz locally without the frontend
+    - Add below configuration to query-service section at `docker/clickhouse-setup/docker-compose.yaml#L38`
+
+    ```docker
+    ports:
+      - "8080:8080"
+    ```
+  - If you are using x86_64 processors (All Intel/AMD processors) run `sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d`
+  - If you are on arm64 processors (Apple M1 Macbooks) run `sudo docker-compose -f docker/clickhouse-setup/docker-compose.arm.yaml up -d`
+- `cd ../frontend` and change baseURL to `http://localhost:8080` in file `src/constants/env.ts`
+- `yarn install`
+- `yarn dev`
+
+> Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh`
+
+### 3.2 Contribute to Frontend without installing SigNoz backend
+
+If you don't want to install SigNoz backend just for doing frontend development, we can provide you with test environments which you can use as the backend. Please ping us in #contributing channel in our [slack community](https://signoz.io/slack) and we will DM you with `<test environment URL>`
+
+- `git clone https://github.com/SigNoz/signoz.git && cd signoz/frontend`
+- Create a file `.env` with `FRONTEND_API_ENDPOINT=<test environment URL>`
+- `yarn install`
+- `yarn dev`
+
+**_Frontend should now be accessible at `http://localhost:3301/application`_**
+
+# 4. Contribute to Query-Service
+
+Need to update [https://github.com/SigNoz/signoz/tree/main/pkg/query-service](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)
+
+### 4.1 To run ClickHouse setup (recommended for local development)
+
+- git clone https://github.com/SigNoz/signoz.git
+- run `cd signoz` to move to signoz directory
+- run `sudo make dev-setup` to configure local setup to run query-service
+- comment out frontend service section at `docker/clickhouse-setup/docker-compose.yaml`
+- comment out query-service section at `docker/clickhouse-setup/docker-compose.yaml`
+- add below configuration to clickhouse section at `docker/clickhouse-setup/docker-compose.yaml`
+```docker
+    expose:
+      - 9000
+    ports:
+      - 9001:9000
+```
+
+- run `cd pkg/query-service/` to move to query-service directory
+- Open ./constants/constants.go
+    - Replace ```const RELATIONAL_DATASOURCE_PATH = "/var/lib/signoz/signoz.db"``` \
+        with ```const RELATIONAL_DATASOURCE_PATH = "./signoz.db".```
+
+- Install signoz locally without the frontend and query-service
+  - If you are using x86_64 processors (All Intel/AMD processors) run `sudo make run-x86`
+  - If you are on arm64 processors (Apple M1 Macbooks) run `sudo make run-arm`
+
+#### 4.2 Run locally
+```console
+ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse go run main.go
+```
+
+> Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh`
+
+**_Query Service should now be available at `http://localhost:8080`_**
+
+> If you want to see how, frontend plays with query service, you can run frontend also in you local env with the baseURL changed to `http://localhost:8080` in file `src/constants/env.ts` as the query-service is now running at port `8080`
+
+---
+<!-- Instead of configuring a local setup, you can also use [Gitpod](https://www.gitpod.io/), a VSCode-based Web IDE.
+
+Click the button below. A workspace with all required environments will be created.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/SigNoz/signoz)
+
+> To use it on your forked repo, edit the 'Open in Gitpod' button url to `https://gitpod.io/#https://github.com/<your-github-username>/signoz` -->
+
+# 5. Contribute to SigNoz Helm Chart
+
+Need to update [https://github.com/SigNoz/charts](https://github.com/SigNoz/charts).
+
+### 5.1 To run helm chart for local development
+
+- run `git clone https://github.com/SigNoz/charts.git` followed by `cd charts`
+- it is recommended to use lightweight kubernetes (k8s) cluster for local development:
+  - [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
+  - [k3d](https://k3d.io/#installation)
+  - [minikube](https://minikube.sigs.k8s.io/docs/start/)
+- create a k8s cluster and make sure `kubectl` points to the locally created k8s cluster
+- run `make dev-install` to install SigNoz chart with `my-release` release name in `platform` namespace.
+- run `kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301` to make SigNoz UI available at [localhost:3301](http://localhost:3301)
+
+**To install HotROD sample app:**
+
+```bash
+curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-install.sh \
+  | HELM_RELEASE=my-release SIGNOZ_NAMESPACE=platform bash
+```
+
+**To load data with HotROD sample app:**
+
+```bash
+kubectl -n sample-application run strzal --image=djbingham/curl \
+  --restart='OnFailure' -i --tty --rm --command -- curl -X POST -F \
+  'locust_count=6' -F 'hatch_rate=2' http://locust-master:8089/swarm
+```
+
+**To stop the load generation:**
+
+```bash
+kubectl -n sample-application run strzal --image=djbingham/curl \
+  --restart='OnFailure' -i --tty --rm --command -- curl \
+  http://locust-master:8089/stop
+```
+
+**To delete HotROD sample app:**
+
+```bash
+curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-delete.sh \
+  | HOTROD_NAMESPACE=sample-application bash
+```
+
+---
+
+Again, feel free to ping us on `#contributing` or `#contributing-frontend` on our slack community if you need any help on this :)
+

From 8477aebc8e16aa8885ff0188808c5d74446c5bfb Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 12:27:28 +0530
Subject: [PATCH 02/16] V2

---
 CONTRIBUTING.md | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ca6eef6f25..b53a00b588 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,11 +1,13 @@
 ## Welcome to SigNoz contributing section. Thank you for taking out the time to contribute to this project.
 
-Sections:
-1. [General Guidelines](#1-general-instructions) 
-2. [How to Contribute](#2-how-to-contribute)
-3. [Develop Frontend](#3-develop-frontend)
-4. [Contribute to Query-Service](#4-contribute-to-query-service)
-5. [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart)
+## Sections:
+- [General Guidelines](#1-general-instructions) 
+- [How to Contribute](#2-how-to-contribute)
+- [Develop Frontend](#3-develop-frontend)
+  - [Contribute to Frontend with Docker installation of SigNoz](#31-contribute-to-frontend-with-docker-installation-of-signoz)
+  - [Contribute to Frontend without installing SigNoz backend](#32-contribute-to-frontend-without-installing-signoz-backend)
+- [Contribute to Query-Service](#4-contribute-to-query-service)
+- [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart)
 
 # 1. General Instructions
 
@@ -36,7 +38,7 @@ and open a pull request(s). Unless your change is small, Please consider submitt
   stability and quality of the component.
 
 
-You can always reach out to `ankit@signoz.io` to understand more about the repo and product. We are very responsive over email and [slack](https://signoz.io/slack).
+You can always reach out to `ankit@signoz.io` to understand more about the repo and product. We are very responsive over email and [SLACK](https://signoz.io/slack).
 
 - If you find any bugs, please create an issue
 - If you find anything missing in documentation, you can create an issue with label **documentation**
@@ -132,14 +134,14 @@ Need to update [https://github.com/SigNoz/signoz/tree/main/pkg/query-service](ht
   - If you are using x86_64 processors (All Intel/AMD processors) run `sudo make run-x86`
   - If you are on arm64 processors (Apple M1 Macbooks) run `sudo make run-arm`
 
-#### 4.2 Run locally
+#### Run locally
 ```console
 ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse go run main.go
 ```
 
 > Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh`
 
-**_Query Service should now be available at `http://localhost:8080`_**
+**_Query Service should now be available at [http://localhost:8080](http://localhost:8080)_**
 
 > If you want to see how, frontend plays with query service, you can run frontend also in you local env with the baseURL changed to `http://localhost:8080` in file `src/constants/env.ts` as the query-service is now running at port `8080`
 

From 54e09e1292a7e9a073a54b70a97315ed99ee7c6a Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 13:48:18 +0530
Subject: [PATCH 03/16] v3

---
 CONTRIBUTING.md | 137 +++++++++++++++++++++++++++++-------------------
 1 file changed, 84 insertions(+), 53 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b53a00b588..8a3daaabcc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,10 @@
-## Welcome to SigNoz contributing section. Thank you for taking out the time to contribute to this project.
+# Contributing Guidelines
+
+#### Welcome to SigNoz Contributing section 🎉
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
 
 ## Sections:
 - [General Guidelines](#1-general-instructions) 
@@ -9,69 +15,87 @@
 - [Contribute to Query-Service](#4-contribute-to-query-service)
 - [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart)
 
-# 1. General Instructions
+# 1. General Instructions 📝
 
-**Before making any significant changes, please open an issue**. Each issue
-should describe the following:
+Before making any significant changes and before filing an issue, please check [existing open](https://github.com/SigNoz/signoz/issues?q=is%3Aopen+is%3Aissue), or [recently closed](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. 
 
-* Requirement - what kind of use case are you trying to solve?
-* Proposal - what do you suggest to solve the problem or improve the existing
+#### Details like these are incredibly useful:
+
+- **Requirement** - what kind of use case are you trying to solve?
+- **Proposal** - what do you suggest to solve the problem or improve the existing
   situation?
-* Any open questions to address
+- Any open questions to address❓
+
+#### If you are reporting a bug, details like these are incredibly useful:
+
+- A reproducible test case or series of steps.
+- The version of our code being used.
+- Any modifications you've made relevant to the bug🐞.
+- Anything unusual about your environment or deployment.
+
+<hr>
 
 Discussing your proposed changes ahead of time will make the contribution
-process smooth for everyone. Once the approach is agreed upon, make your changes
-and open a pull request(s). Unless your change is small, Please consider submitting different PRs:
+process smooth for everyone. 
 
-* First PR should include the overall structure of the new component:
-  * Readme, configuration, interfaces or base classes etc...
+Once the approach is agreed upon✅, make your changes
+and open a Pull Request(s). 
+
+**Note:** Unless your change is small, **please** consider submitting different Pull Rrequest(s):
+
+* 1️⃣ First PR should include the overall structure of the new component:
+  * Readme, configuration, interfaces or base classes, etc...
   * This PR is usually trivial to review, so the size limit does not apply to
     it.
-* Second PR should include the concrete implementation of the component. If the
-  size of this PR is larger than the recommended size consider splitting it in
+* 2️⃣ Second PR should include the concrete implementation of the component. If the
+  size of this PR is larger than the recommended size, consider splitting it into
   multiple PRs.
 * If there are multiple sub-component then ideally each one should be implemented as
   a separate pull request.
-* Last PR should include changes to any user facing documentation. And should include
-  end to end tests if applicable. The component must be enabled
+* Last PR should include changes to any user-facing documentation. And should include
+  end-to-end tests if applicable. The component must be enabled
   only after sufficient testing, and there is enough confidence in the
   stability and quality of the component.
 
 
 You can always reach out to `ankit@signoz.io` to understand more about the repo and product. We are very responsive over email and [SLACK](https://signoz.io/slack).
 
-- If you find any bugs, please create an issue
-- If you find anything missing in documentation, you can create an issue with label **documentation**
-- If you want to build any new feature, please create an issue with label `enhancement`
-- If you want to discuss something about the product, start a new [discussion](https://github.com/SigNoz/signoz/discussions)
+- If you find any **bugs** → please create an **issue.**
+- If you find anything **missing** in documentation → you can create an issue with the label **`documentation`**.
+- If you want to build any **new feature** → please create an issue with the label **`enhancement`**.
+- If you want to **discuss** something about the product, start a new [**discussion**.](https://github.com/SigNoz/signoz/discussions)
 
-### Conventions to follow when submitting commits, PRs
+<hr>
 
-1. We try to follow https://www.conventionalcommits.org/en/v1.0.0/
+### Conventions to follow when submitting Commits and Pull Request(s).
 
-More specifically the commits and PRs should have type specifiers prefixed in the name. [This](https://www.conventionalcommits.org/en/v1.0.0/#specification) should give you a better idea.
+- We try to follow [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)
+, more specifically the commits and PRs should have type specifiers prefixed in the name. [This](https://www.conventionalcommits.org/en/v1.0.0/#specification) should give you a better idea.
 
-e.g. If you are submitting a fix for an issue in frontend - PR name should be prefixed with `fix(FE):`
+e.g. If you are submitting a fix for an issue in frontend, the PR name should be prefixed with **`fix(FE):`**
 
-2. Follow [GitHub Flow](https://guides.github.com/introduction/flow/) guidelines for your contribution flows
+- Follow [GitHub Flow](https://guides.github.com/introduction/flow/) guidelines for your contribution flows.
 
-3. Feel free to ping us on `#contributing` or `#contributing-frontend` on our slack community if you need any help on this :)
+- Feel free to ping us on [#contributing](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [#contributing-frontend](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :)
 
+<hr>
 
-# 2. How to Contribute
+# 2. How to Contribute 🙋🏻‍♂️
 
-There are primarily 2 areas in which you can contribute in SigNoz
+#### There are primarily 2 areas in which you can contribute to SigNoz
 
-- Frontend ( written in Typescript, React)
-- Backend - ( Query Service - written in Go)
+- **Frontend** (Written in Typescript, React)
+- **Backend** (Query Service,  written in Go)
 
-Depending upon your area of expertise & interest, you can chose one or more to contribute. Below are detailed instructions to contribute in each area
+Depending upon your area of expertise & interest, you can choose one or more to contribute. Below are detailed instructions to contribute in each area.
 
-> Please note: If you want to work on an issue, please ask the maintainers to assign the issue to you before starting work on it. This would help us understand who is working on an issue and prevent duplicate work. 🙏🏻
+**Please note:** If you want to work on an issue, please ask the maintainers to assign the issue to you before starting work on it. This would help us understand who is working on an issue and prevent duplicate work. 🙏🏻
 
-> If you just raise a PR, without the corresponding issue being assigned to you - it may not be accepted.
+⚠️ If you just raise a PR, without the corresponding issue being assigned to you - it may not be accepted.
 
-# 3. Develop Frontend
+<hr>
+
+# 3. Develop Frontend 🌝
 
 Need to update [https://github.com/SigNoz/signoz/tree/main/frontend](https://github.com/SigNoz/signoz/tree/main/frontend)
 
@@ -97,7 +121,7 @@ Need to update [https://github.com/SigNoz/signoz/tree/main/frontend](https://git
 
 ### 3.2 Contribute to Frontend without installing SigNoz backend
 
-If you don't want to install SigNoz backend just for doing frontend development, we can provide you with test environments which you can use as the backend. Please ping us in #contributing channel in our [slack community](https://signoz.io/slack) and we will DM you with `<test environment URL>`
+If you don't want to install the SigNoz backend just for doing frontend development, we can provide you with test environments that you can use as the backend. Please ping us in the #contributing channel in our [slack community](https://signoz.io/slack) and we will DM you with `<test environment URL>`
 
 - `git clone https://github.com/SigNoz/signoz.git && cd signoz/frontend`
 - Create a file `.env` with `FRONTEND_API_ENDPOINT=<test environment URL>`
@@ -106,18 +130,23 @@ If you don't want to install SigNoz backend just for doing frontend development,
 
 **_Frontend should now be accessible at `http://localhost:3301/application`_**
 
-# 4. Contribute to Query-Service
+<hr>
 
-Need to update [https://github.com/SigNoz/signoz/tree/main/pkg/query-service](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)
+# 4. Contribute to Backend (Query-Service) 🌕
+
+Need to update: [**https://github.com/SigNoz/signoz/tree/main/pkg/query-service**](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)
 
 ### 4.1 To run ClickHouse setup (recommended for local development)
 
-- git clone https://github.com/SigNoz/signoz.git
-- run `cd signoz` to move to signoz directory
-- run `sudo make dev-setup` to configure local setup to run query-service
-- comment out frontend service section at `docker/clickhouse-setup/docker-compose.yaml`
-- comment out query-service section at `docker/clickhouse-setup/docker-compose.yaml`
-- add below configuration to clickhouse section at `docker/clickhouse-setup/docker-compose.yaml`
+- Clone SigNoz,
+```
+git clone https://github.com/SigNoz/signoz.git
+```
+- run `cd signoz` to move to signoz directory,
+- run `sudo make dev-setup` to configure local setup to run query-service,
+- comment out frontend service section at [`docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
+- comment out query-service section at [`docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
+- add below configuration to clickhouse section at [`docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
 ```docker
     expose:
       - 9000
@@ -125,14 +154,14 @@ Need to update [https://github.com/SigNoz/signoz/tree/main/pkg/query-service](ht
       - 9001:9000
 ```
 
-- run `cd pkg/query-service/` to move to query-service directory
-- Open ./constants/constants.go
+- run `cd pkg/query-service/` to move to `query-service` directory,
+- Open [`./constants/constants.go`,](https://github.com/SigNoz/signoz/blob/develop/pkg/query-service/constants/constants.go)
     - Replace ```const RELATIONAL_DATASOURCE_PATH = "/var/lib/signoz/signoz.db"``` \
-        with ```const RELATIONAL_DATASOURCE_PATH = "./signoz.db".```
+        with →  ```const RELATIONAL_DATASOURCE_PATH = "./signoz.db".```
 
-- Install signoz locally without the frontend and query-service
-  - If you are using x86_64 processors (All Intel/AMD processors) run `sudo make run-x86`
-  - If you are on arm64 processors (Apple M1 Macbooks) run `sudo make run-arm`
+- Now, install SigNoz locally **without** the `frontend` and `query-service`,
+  - If you are using `x86_64` processors (All Intel/AMD processors) run `sudo make run-x86`
+  - If you are on `arm64` processors (Apple M1 Macs) run `sudo make run-arm`
 
 #### Run locally
 ```console
@@ -143,7 +172,7 @@ ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse go run main.go
 
 **_Query Service should now be available at [http://localhost:8080](http://localhost:8080)_**
 
-> If you want to see how, frontend plays with query service, you can run frontend also in you local env with the baseURL changed to `http://localhost:8080` in file `src/constants/env.ts` as the query-service is now running at port `8080`
+> If you want to see how the frontend plays with query service, you can run the frontend also in your local env with the baseURL changed to `http://localhost:8080` in file `src/constants/env.ts` as the query-service is now running at port `8080`
 
 ---
 <!-- Instead of configuring a local setup, you can also use [Gitpod](https://www.gitpod.io/), a VSCode-based Web IDE.
@@ -152,7 +181,9 @@ Click the button below. A workspace with all required environments will be creat
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/SigNoz/signoz)
 
-> To use it on your forked repo, edit the 'Open in Gitpod' button url to `https://gitpod.io/#https://github.com/<your-github-username>/signoz` -->
+> To use it on your forked repo, edit the 'Open in Gitpod' button URL to `https://gitpod.io/#https://github.com/<your-github-username>/signoz` -->
+
+<hr>
 
 # 5. Contribute to SigNoz Helm Chart
 
@@ -169,14 +200,14 @@ Need to update [https://github.com/SigNoz/charts](https://github.com/SigNoz/char
 - run `make dev-install` to install SigNoz chart with `my-release` release name in `platform` namespace.
 - run `kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301` to make SigNoz UI available at [localhost:3301](http://localhost:3301)
 
-**To install HotROD sample app:**
+**To install the HotROD sample app:**
 
 ```bash
 curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-install.sh \
   | HELM_RELEASE=my-release SIGNOZ_NAMESPACE=platform bash
 ```
 
-**To load data with HotROD sample app:**
+**To load data with the HotROD sample app:**
 
 ```bash
 kubectl -n sample-application run strzal --image=djbingham/curl \
@@ -192,7 +223,7 @@ kubectl -n sample-application run strzal --image=djbingham/curl \
   http://locust-master:8089/stop
 ```
 
-**To delete HotROD sample app:**
+**To delete the HotROD sample app:**
 
 ```bash
 curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-delete.sh \

From 61b79742dc397de0c7c130057181637dbd838f30 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 17:17:37 +0530
Subject: [PATCH 04/16] v4

---
 CONTRIBUTING.md | 192 +++++++++++++++++++++++++++++++-----------------
 1 file changed, 124 insertions(+), 68 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8a3daaabcc..3b2bf060d8 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,18 +6,30 @@ Thank you for your interest in contributing to our project. Whether it's a bug r
 
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
 
+## Finding contributions to work on 💬
+
+Looking at the existing issues is a great way to find something to contribute on. 
+Also, have a look at these [good first issues labels](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start with.
+
 ## Sections:
-- [General Guidelines](#1-general-instructions) 
-- [How to Contribute](#2-how-to-contribute)
-- [Develop Frontend](#3-develop-frontend)
+- [General Instructions](#1-general-instructions-) 
+    - [For Creating Issue(s)](#11-for-creating-issues)
+    - [For Pull Requests(s)](#12-for-pull-requests)
+- [How to Contribute](#2-how-to-contribute-%EF%B8%8F)
+- [Develop Frontend](#3-develop-frontend-)
   - [Contribute to Frontend with Docker installation of SigNoz](#31-contribute-to-frontend-with-docker-installation-of-signoz)
   - [Contribute to Frontend without installing SigNoz backend](#32-contribute-to-frontend-without-installing-signoz-backend)
-- [Contribute to Query-Service](#4-contribute-to-query-service)
-- [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart)
+- [Contribute to Backend (Query-Service)](#4-contribute-to-backend-query-service-)
+    - [To run ClickHouse setup](#41-to-run-clickhouse-setup-recommended-for-local-development)
+- [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart-)
+    - [To run helm chart for local development](#51-to-run-helm-chart-for-local-development)
 
 # 1. General Instructions 📝
 
-Before making any significant changes and before filing an issue, please check [existing open](https://github.com/SigNoz/signoz/issues?q=is%3Aopen+is%3Aissue), or [recently closed](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. 
+## 1.1 For Creating Issue(s)
+Before making any significant changes and before filing a new issue, please check [existing open](https://github.com/SigNoz/signoz/issues?q=is%3Aopen+is%3Aissue), or [recently closed](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aclosed) issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. 
+
+**Issue Types** - [Bug Report](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=bug_report.md&title=) | [Feature Request](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=feature_request.md&title=) | [Performance Issue Report](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=performance-issue-report.md&title=) | [Report a Security Vulnerability](https://github.com/SigNoz/signoz/security/policy)
 
 #### Details like these are incredibly useful:
 
@@ -33,12 +45,16 @@ Before making any significant changes and before filing an issue, please check [
 - Any modifications you've made relevant to the bug🐞.
 - Anything unusual about your environment or deployment.
 
+Discussing your proposed changes ahead of time will make the contribution
+process smooth for everyone 🙌.
+
+ **[`^top^`](#)**
+ 
 <hr>
 
-Discussing your proposed changes ahead of time will make the contribution
-process smooth for everyone. 
+## 1.2 For Pull Request(s)
 
-Once the approach is agreed upon✅, make your changes
+Once the approach is agreed upon ✅, make your changes
 and open a Pull Request(s). 
 
 **Note:** Unless your change is small, **please** consider submitting different Pull Rrequest(s):
@@ -48,11 +64,11 @@ and open a Pull Request(s).
   * This PR is usually trivial to review, so the size limit does not apply to
     it.
 * 2️⃣ Second PR should include the concrete implementation of the component. If the
-  size of this PR is larger than the recommended size, consider splitting it into
+  size of this PR is larger than the recommended size, consider **splitting** ⚔️ it into
   multiple PRs.
 * If there are multiple sub-component then ideally each one should be implemented as
-  a separate pull request.
-* Last PR should include changes to any user-facing documentation. And should include
+  a **separate** pull request.
+* Last PR should include changes to **any user-facing documentation.** And should include
   end-to-end tests if applicable. The component must be enabled
   only after sufficient testing, and there is enough confidence in the
   stability and quality of the component.
@@ -60,6 +76,7 @@ and open a Pull Request(s).
 
 You can always reach out to `ankit@signoz.io` to understand more about the repo and product. We are very responsive over email and [SLACK](https://signoz.io/slack).
 
+### Pointers:
 - If you find any **bugs** → please create an **issue.**
 - If you find anything **missing** in documentation → you can create an issue with the label **`documentation`**.
 - If you want to build any **new feature** → please create an issue with the label **`enhancement`**.
@@ -69,23 +86,24 @@ You can always reach out to `ankit@signoz.io` to understand more about the repo
 
 ### Conventions to follow when submitting Commits and Pull Request(s).
 
-- We try to follow [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)
-, more specifically the commits and PRs should have type specifiers prefixed in the name. [This](https://www.conventionalcommits.org/en/v1.0.0/#specification) should give you a better idea.
+We try to follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), more specifically the commits and PRs **should have type specifiers** prefixed in the name. [This](https://www.conventionalcommits.org/en/v1.0.0/#specification) should give you a better idea.
 
 e.g. If you are submitting a fix for an issue in frontend, the PR name should be prefixed with **`fix(FE):`**
 
 - Follow [GitHub Flow](https://guides.github.com/introduction/flow/) guidelines for your contribution flows.
 
-- Feel free to ping us on [#contributing](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [#contributing-frontend](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :)
+- Feel free to ping us on [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [`#contributing-frontend`](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :)
 
+ **[`^top^`](#)**
+ 
 <hr>
 
 # 2. How to Contribute 🙋🏻‍♂️
 
 #### There are primarily 2 areas in which you can contribute to SigNoz
 
-- **Frontend** (Written in Typescript, React)
-- **Backend** (Query Service,  written in Go)
+- [**Frontend**](#3-develop-frontend-) (Written in Typescript, React)
+- [**Backend**]() (Query Service,  written in Go)
 
 Depending upon your area of expertise & interest, you can choose one or more to contribute. Below are detailed instructions to contribute in each area.
 
@@ -93,66 +111,92 @@ Depending upon your area of expertise & interest, you can choose one or more to
 
 ⚠️ If you just raise a PR, without the corresponding issue being assigned to you - it may not be accepted.
 
+ **[`^top^`](#)**
+ 
 <hr>
 
-# 3. Develop Frontend 🌝
+# 3. Develop Frontend 🌚
 
-Need to update [https://github.com/SigNoz/signoz/tree/main/frontend](https://github.com/SigNoz/signoz/tree/main/frontend)
+**Need to Update: [https://github.com/SigNoz/signoz/tree/main/frontend](https://github.com/SigNoz/signoz/tree/main/frontend)**
 
 ### 3.1 Contribute to Frontend with Docker installation of SigNoz
 
-- `git clone https://github.com/SigNoz/signoz.git && cd signoz`
-- comment out frontend service section at `deploy/docker/clickhouse-setup/docker-compose.yaml#L62`
-- run `cd deploy` to move to deploy directory
-- Install signoz locally without the frontend
-    - Add below configuration to query-service section at `docker/clickhouse-setup/docker-compose.yaml#L38`
-
+- Clone the SigNoz repository and cd into signoz directory,
+  ```
+  git clone https://github.com/SigNoz/signoz.git && cd signoz
+  ```
+- Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/a09a4c264e49694c331c08c3dd15cc2bf6dc9106/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
+- run `cd deploy` to move to deploy directory,
+- Install signoz locally **without** the frontend,
+    - Add below configuration to query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/a09a4c264e49694c331c08c3dd15cc2bf6dc9106/deploy/docker/clickhouse-setup/docker-compose.yaml#L47)
     ```docker
     ports:
       - "8080:8080"
     ```
-  - If you are using x86_64 processors (All Intel/AMD processors) run `sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d`
-  - If you are on arm64 processors (Apple M1 Macbooks) run `sudo docker-compose -f docker/clickhouse-setup/docker-compose.arm.yaml up -d`
-- `cd ../frontend` and change baseURL to `http://localhost:8080` in file `src/constants/env.ts`
-- `yarn install`
-- `yarn dev`
+    
+  - If you are using `x86_64` processors (All Intel/AMD processors) run 
+    ```
+    sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d
+    ```
+  - If you are on `arm64` processors (Apple M1 Macbooks) run 
+    ```
+    sudo docker-compose -f docker/clickhouse-setup/docker-compose.arm.yaml up -d
+    ```
+- `cd ../frontend` and change baseURL to `http://localhost:8080` in file [`src/constants/env.ts`](https://github.com/SigNoz/signoz/blob/develop/frontend/src/constants/env.ts)
+- Next, 
+  ```
+  yarn install
+  yarn dev
+  ```
 
-> Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh`
+### Important Notes:
+The Maintainers / Contributors who will change Line Numbers of `Frontend` & `Query-Section`, please update line numbers in [`/.scripts/commentLinesForSetup.sh`](https://github.com/SigNoz/signoz/blob/develop/.scripts/commentLinesForSetup.sh)
+
+ **[`^top^`](#)**
 
 ### 3.2 Contribute to Frontend without installing SigNoz backend
 
-If you don't want to install the SigNoz backend just for doing frontend development, we can provide you with test environments that you can use as the backend. Please ping us in the #contributing channel in our [slack community](https://signoz.io/slack) and we will DM you with `<test environment URL>`
+If you don't want to install the SigNoz backend just for doing frontend development, we can provide you with test environments that you can use as the backend. 
 
-- `git clone https://github.com/SigNoz/signoz.git && cd signoz/frontend`
-- Create a file `.env` with `FRONTEND_API_ENDPOINT=<test environment URL>`
-- `yarn install`
-- `yarn dev`
+- Clone the SigNoz repository and cd into signoz/frontend directory,
+  ```
+  git clone https://github.com/SigNoz/signoz.git && cd signoz/frontend
+  ````
+- Create a file `.env` in the `frontend` directory with `FRONTEND_API_ENDPOINT=<test environment URL>`
+- Next, 
+  ```
+  yarn install
+  yarn dev
+  ```
 
-**_Frontend should now be accessible at `http://localhost:3301/application`_**
+Please ping us in the [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M) channel or ask `@Prashant Shahi` in our [Slack Community](https://signoz.io/slack)  and we will DM you with `<test environment URL>`.
 
+**Frontend should now be accessible at** [`http://localhost:3301/application`](http://localhost:3301/application)
+
+ **[`^top^`](#)**
+ 
 <hr>
 
-# 4. Contribute to Backend (Query-Service) 🌕
+# 4. Contribute to Backend (Query-Service) 🌑
 
-Need to update: [**https://github.com/SigNoz/signoz/tree/main/pkg/query-service**](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)
+**Need to Update:** [**https://github.com/SigNoz/signoz/tree/main/pkg/query-service**](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)
 
 ### 4.1 To run ClickHouse setup (recommended for local development)
 
-- Clone SigNoz,
+- Clone the SigNoz repository and cd into signoz directory,
 ```
-git clone https://github.com/SigNoz/signoz.git
+git clone https://github.com/SigNoz/signoz.git && cd signoz
 ```
-- run `cd signoz` to move to signoz directory,
 - run `sudo make dev-setup` to configure local setup to run query-service,
-- comment out frontend service section at [`docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
-- comment out query-service section at [`docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
-- add below configuration to clickhouse section at [`docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
-```docker
-    expose:
-      - 9000
-    ports:
-      - 9001:9000
-```
+- comment out frontend service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
+- comment out query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
+- add below configuration to clickhouse section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
+  ```
+  expose:
+    - 9000
+  ports:
+    - 9001:9000
+  ```
 
 - run `cd pkg/query-service/` to move to `query-service` directory,
 - Open [`./constants/constants.go`,](https://github.com/SigNoz/signoz/blob/develop/pkg/query-service/constants/constants.go)
@@ -163,18 +207,19 @@ git clone https://github.com/SigNoz/signoz.git
   - If you are using `x86_64` processors (All Intel/AMD processors) run `sudo make run-x86`
   - If you are on `arm64` processors (Apple M1 Macs) run `sudo make run-arm`
 
-#### Run locally
-```console
+#### Run locally,
+```
 ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse go run main.go
 ```
+### Important Note:
+The Maintainers / Contributors who will change Line Numbers of `Frontend` & `Query-Section`, please update line numbers in [`/.scripts/commentLinesForSetup.sh`](https://github.com/SigNoz/signoz/blob/develop/.scripts/commentLinesForSetup.sh)
 
-> Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh`
 
-**_Query Service should now be available at [http://localhost:8080](http://localhost:8080)_**
 
-> If you want to see how the frontend plays with query service, you can run the frontend also in your local env with the baseURL changed to `http://localhost:8080` in file `src/constants/env.ts` as the query-service is now running at port `8080`
+**Query Service should now be available at** [`http://localhost:8080`](http://localhost:8080)
+
+If you want to see how the frontend plays with query service, you can run the frontend also in your local env with the baseURL changed to `http://localhost:8080` in file [`frontend/src/constants/env.ts`](https://github.com/SigNoz/signoz/blob/develop/frontend/src/constants/env.ts) as the `query-service` is now running at port `8080`.
 
----
 <!-- Instead of configuring a local setup, you can also use [Gitpod](https://www.gitpod.io/), a VSCode-based Web IDE.
 
 Click the button below. A workspace with all required environments will be created.
@@ -183,31 +228,40 @@ Click the button below. A workspace with all required environments will be creat
 
 > To use it on your forked repo, edit the 'Open in Gitpod' button URL to `https://gitpod.io/#https://github.com/<your-github-username>/signoz` -->
 
+ **[`^top^`](#)**
+ 
 <hr>
 
-# 5. Contribute to SigNoz Helm Chart
+# 5. Contribute to SigNoz Helm Chart 📊
 
-Need to update [https://github.com/SigNoz/charts](https://github.com/SigNoz/charts).
+**Need to Update: [https://github.com/SigNoz/charts](https://github.com/SigNoz/charts).**
 
 ### 5.1 To run helm chart for local development
 
-- run `git clone https://github.com/SigNoz/charts.git` followed by `cd charts`
-- it is recommended to use lightweight kubernetes (k8s) cluster for local development:
+- Clone the SigNoz repository and cd into charts directory,
+```
+git clone https://github.com/SigNoz/charts.git && cd charts
+``` 
+- It is recommended to use lightweight kubernetes (k8s) cluster for local development:
   - [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
   - [k3d](https://k3d.io/#installation)
   - [minikube](https://minikube.sigs.k8s.io/docs/start/)
-- create a k8s cluster and make sure `kubectl` points to the locally created k8s cluster
-- run `make dev-install` to install SigNoz chart with `my-release` release name in `platform` namespace.
-- run `kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301` to make SigNoz UI available at [localhost:3301](http://localhost:3301)
+- create a k8s cluster and make sure `kubectl` points to the locally created k8s cluster,
+- run `make dev-install` to install SigNoz chart with `my-release` release name in `platform` namespace,
+- next run,
+```
+kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301
+``` 
+to make SigNoz UI available at [localhost:3301](http://localhost:3301)
 
-**To install the HotROD sample app:**
+**5.1.1 To install the HotROD sample app:**
 
 ```bash
 curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-install.sh \
   | HELM_RELEASE=my-release SIGNOZ_NAMESPACE=platform bash
 ```
 
-**To load data with the HotROD sample app:**
+**5.1.2 To load data with the HotROD sample app:**
 
 ```bash
 kubectl -n sample-application run strzal --image=djbingham/curl \
@@ -215,7 +269,7 @@ kubectl -n sample-application run strzal --image=djbingham/curl \
   'locust_count=6' -F 'hatch_rate=2' http://locust-master:8089/swarm
 ```
 
-**To stop the load generation:**
+**5.1.3 To stop the load generation:**
 
 ```bash
 kubectl -n sample-application run strzal --image=djbingham/curl \
@@ -223,13 +277,15 @@ kubectl -n sample-application run strzal --image=djbingham/curl \
   http://locust-master:8089/stop
 ```
 
-**To delete the HotROD sample app:**
+**5.1.4 To delete the HotROD sample app:**
 
 ```bash
 curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-delete.sh \
   | HOTROD_NAMESPACE=sample-application bash
 ```
 
+ **[`^top^`](#)**
+ 
 ---
 
 Again, feel free to ping us on `#contributing` or `#contributing-frontend` on our slack community if you need any help on this :)

From ef69505bf9a21b7438985161d1c9edf6d4935f4e Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 17:22:31 +0530
Subject: [PATCH 05/16] remove arm version of docker-compose file

---
 CONTRIBUTING.md | 10 +++-------
 1 file changed, 3 insertions(+), 7 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3b2bf060d8..ae2f595b2f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -125,23 +125,19 @@ Depending upon your area of expertise & interest, you can choose one or more to
   ```
   git clone https://github.com/SigNoz/signoz.git && cd signoz
   ```
-- Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/a09a4c264e49694c331c08c3dd15cc2bf6dc9106/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
+- Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
 - run `cd deploy` to move to deploy directory,
 - Install signoz locally **without** the frontend,
-    - Add below configuration to query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/a09a4c264e49694c331c08c3dd15cc2bf6dc9106/deploy/docker/clickhouse-setup/docker-compose.yaml#L47)
+    - Add below configuration to query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L47)
     ```docker
     ports:
       - "8080:8080"
     ```
     
-  - If you are using `x86_64` processors (All Intel/AMD processors) run 
+  - Next run,
     ```
     sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d
     ```
-  - If you are on `arm64` processors (Apple M1 Macbooks) run 
-    ```
-    sudo docker-compose -f docker/clickhouse-setup/docker-compose.arm.yaml up -d
-    ```
 - `cd ../frontend` and change baseURL to `http://localhost:8080` in file [`src/constants/env.ts`](https://github.com/SigNoz/signoz/blob/develop/frontend/src/constants/env.ts)
 - Next, 
   ```

From ab52538e91e622e4e7239a965d91d0a76b1cb356 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 17:43:23 +0530
Subject: [PATCH 06/16] v5

---
 CONTRIBUTING.md | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ae2f595b2f..085e40742f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -54,8 +54,23 @@ process smooth for everyone 🙌.
 
 ## 1.2 For Pull Request(s)
 
-Once the approach is agreed upon ✅, make your changes
-and open a Pull Request(s). 
+Contributions via pull requests are much appreciated. Once the approach is agreed upon ✅, make your changes and open a Pull Request(s). 
+Before sending us a pull request, please ensure that,
+
+- Fork the SigNoz repo on GitHub, clone it on your machine.
+- Create a branch with your changes.
+- You are working against the latest source on the `develop` branch.
+- Modify the source; please focus only on the specific change you are contributing.
+- Ensure local tests pass.
+- Commit to your fork using clear commit messages.
+- Send us a pull request, answering any default questions in the pull request interface.
+- Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation
+- Once you've pushed your commits to GitHub, make sure that your branch can be auto-merged (there are no merge conflicts). If not, on your computer, merge main into your branch, resolve any merge conflicts, make sure everything still runs correctly and passes all the tests, and then push up those changes.
+- Once the change has been approved and merged, we will inform you in a comment.
+
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
 **Note:** Unless your change is small, **please** consider submitting different Pull Rrequest(s):
 
@@ -284,5 +299,10 @@ curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-del
  
 ---
 
+## License
+
+By contributing to FBShipIt, you agree that your contributions will be licensed under its MIT license.
+
 Again, feel free to ping us on `#contributing` or `#contributing-frontend` on our slack community if you need any help on this :)
 
+Thank You!

From 0ceaa56679545b3663cbb74f8367b8fb33ae8dd4 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 17:46:48 +0530
Subject: [PATCH 07/16] v6

---
 CONTRIBUTING.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 085e40742f..2dab66f09d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -11,6 +11,7 @@ Please read through this document before submitting any issues or pull requests
 Looking at the existing issues is a great way to find something to contribute on. 
 Also, have a look at these [good first issues labels](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start with.
 
+
 ## Sections:
 - [General Instructions](#1-general-instructions-) 
     - [For Creating Issue(s)](#11-for-creating-issues)
@@ -299,6 +300,17 @@ curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-del
  
 ---
 
+## Other ways to contribute
+
+There are many other ways to get involved with the community and to participate in this project:
+
+- Use the product, submitting GitHub issues when a problem is found.
+- Help code review pull requests and participate in issue threads.
+- Submit a new feature request as an issue.
+- Help answer questions on forums such as Stack Overflow and [SigNoz Community Slack Channel](https://signoz.io/slack).
+- Tell others about the project on Twitter, your blog, etc.
+
+
 ## License
 
 By contributing to FBShipIt, you agree that your contributions will be licensed under its MIT license.

From 3dc1dc970fe746476572f7dbe00162807b3f0907 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 18:00:46 +0530
Subject: [PATCH 08/16] v6

---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2dab66f09d..9bee883ec3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 #### Welcome to SigNoz Contributing section 🎉
 
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
+Hi there! We're thrilled that you'd like to contribute to this project, thank you for your interest. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
 
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
 

From 3e2a6df2005a8d7c9ce0e1b12fd2fcfec406e2ef Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 18:08:02 +0530
Subject: [PATCH 09/16] Update CONTRIBUTING.md

---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9bee883ec3..3809a5dda9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -313,7 +313,7 @@ There are many other ways to get involved with the community and to participate
 
 ## License
 
-By contributing to FBShipIt, you agree that your contributions will be licensed under its MIT license.
+By contributing to SigNoz, you agree that your contributions will be licensed under its MIT license.
 
 Again, feel free to ping us on `#contributing` or `#contributing-frontend` on our slack community if you need any help on this :)
 

From 83f3180641eeddf892399bd2c4a6c77f92ce3871 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 23:28:13 +0530
Subject: [PATCH 10/16] Update CONTRIBUTING.md

---
 CONTRIBUTING.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3809a5dda9..ba5177c79d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -93,9 +93,9 @@ GitHub provides additional document on [forking a repository](https://help.githu
 You can always reach out to `ankit@signoz.io` to understand more about the repo and product. We are very responsive over email and [SLACK](https://signoz.io/slack).
 
 ### Pointers:
-- If you find any **bugs** → please create an **issue.**
+- If you find any **bugs** → please create an [**issue.**](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=bug_report.md&title=)
 - If you find anything **missing** in documentation → you can create an issue with the label **`documentation`**.
-- If you want to build any **new feature** → please create an issue with the label **`enhancement`**.
+- If you want to build any **new feature** → please create an [issue with the label **`enhancement`**.](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=feature_request.md&title=)
 - If you want to **discuss** something about the product, start a new [**discussion**.](https://github.com/SigNoz/signoz/discussions)
 
 <hr>
@@ -119,7 +119,7 @@ e.g. If you are submitting a fix for an issue in frontend, the PR name should be
 #### There are primarily 2 areas in which you can contribute to SigNoz
 
 - [**Frontend**](#3-develop-frontend-) (Written in Typescript, React)
-- [**Backend**]() (Query Service,  written in Go)
+- [**Backend**](#4-contribute-to-backend-query-service-) (Query Service,  written in Go)
 
 Depending upon your area of expertise & interest, you can choose one or more to contribute. Below are detailed instructions to contribute in each area.
 

From 8db4793ad6cb004a03baa1756aa628e74b8d62d5 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 23:33:41 +0530
Subject: [PATCH 11/16] change main branch to develop branch for contribution

---
 CONTRIBUTING.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ba5177c79d..86ecd37ed5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing Guidelines
 
-#### Welcome to SigNoz Contributing section 🎉
+## Welcome to SigNoz Contributing section 🎉
 
 Hi there! We're thrilled that you'd like to contribute to this project, thank you for your interest. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
 
@@ -133,7 +133,7 @@ Depending upon your area of expertise & interest, you can choose one or more to
 
 # 3. Develop Frontend 🌚
 
-**Need to Update: [https://github.com/SigNoz/signoz/tree/main/frontend](https://github.com/SigNoz/signoz/tree/main/frontend)**
+**Need to Update: [https://github.com/SigNoz/signoz/tree/develop/frontend](https://github.com/SigNoz/signoz/tree/develop/frontend)**
 
 ### 3.1 Contribute to Frontend with Docker installation of SigNoz
 
@@ -191,7 +191,7 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi
 
 # 4. Contribute to Backend (Query-Service) 🌑
 
-**Need to Update:** [**https://github.com/SigNoz/signoz/tree/main/pkg/query-service**](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)
+**Need to Update:** [**https://github.com/SigNoz/signoz/tree/develop/pkg/query-service**](https://github.com/SigNoz/signoz/tree/develop/pkg/query-service)
 
 ### 4.1 To run ClickHouse setup (recommended for local development)
 

From 3ea36092f66730d90decf2c2ed29f9cea843d2a7 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Wed, 13 Jul 2022 23:44:25 +0530
Subject: [PATCH 12/16] Update CONTRIBUTING.md

---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 86ecd37ed5..078e7f5ed6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -144,7 +144,7 @@ Depending upon your area of expertise & interest, you can choose one or more to
 - Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
 - run `cd deploy` to move to deploy directory,
 - Install signoz locally **without** the frontend,
-    - Add below configuration to query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L47)
+    - Add / Uncomment the below configuration to query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L47)
     ```docker
     ports:
       - "8080:8080"

From 7da69f6a75c76edefd7ac3118aa67f8910a32fb6 Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Thu, 14 Jul 2022 00:21:59 +0530
Subject: [PATCH 13/16] Update CONTRIBUTING.md

---
 CONTRIBUTING.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 078e7f5ed6..86d4010def 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -200,9 +200,9 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi
 git clone https://github.com/SigNoz/signoz.git && cd signoz
 ```
 - run `sudo make dev-setup` to configure local setup to run query-service,
-- comment out frontend service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
-- comment out query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
-- add below configuration to clickhouse section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
+- Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
+- Comment out `query-service` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L41`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L41)
+- add below configuration to `clickhouse` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
   ```
   expose:
     - 9000
@@ -211,7 +211,7 @@ git clone https://github.com/SigNoz/signoz.git && cd signoz
   ```
 
 - run `cd pkg/query-service/` to move to `query-service` directory,
-- Open [`./constants/constants.go`,](https://github.com/SigNoz/signoz/blob/develop/pkg/query-service/constants/constants.go)
+- Open [`./constants/constants.go#L38`,](https://github.com/SigNoz/signoz/blob/develop/pkg/query-service/constants/constants.go#L38)
     - Replace ```const RELATIONAL_DATASOURCE_PATH = "/var/lib/signoz/signoz.db"``` \
         with →  ```const RELATIONAL_DATASOURCE_PATH = "./signoz.db".```
 

From bebfaa1c4c0f479af1261579848325f0c715914a Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Thu, 14 Jul 2022 22:41:11 +0530
Subject: [PATCH 14/16] Update CONTRIBUTING.md

---
 CONTRIBUTING.md | 91 +++++++++++++++++++++++++++++++++++++------------
 1 file changed, 69 insertions(+), 22 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 86d4010def..4bb6509924 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,6 +6,12 @@ Hi there! We're thrilled that you'd like to contribute to this project, thank yo
 
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
 
+- We accept contributions made to the [SigNoz `develop` branch]()
+- Find all SigNoz Docker Hub images here 
+    - [signoz/frontend](https://hub.docker.com/r/signoz/frontend)
+    - [signoz/query-service](https://hub.docker.com/r/signoz/query-service)
+    - [signoz/otelcontribcol](https://hub.docker.com/r/signoz/otelcontribcol)
+
 ## Finding contributions to work on 💬
 
 Looking at the existing issues is a great way to find something to contribute on. 
@@ -24,6 +30,7 @@ Also, have a look at these [good first issues labels](https://github.com/SigNoz/
     - [To run ClickHouse setup](#41-to-run-clickhouse-setup-recommended-for-local-development)
 - [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart-)
     - [To run helm chart for local development](#51-to-run-helm-chart-for-local-development)
+- [Other Ways to Contribute](#other-ways-to-contribute)
 
 # 1. General Instructions 📝
 
@@ -135,26 +142,43 @@ Depending upon your area of expertise & interest, you can choose one or more to
 
 **Need to Update: [https://github.com/SigNoz/signoz/tree/develop/frontend](https://github.com/SigNoz/signoz/tree/develop/frontend)**
 
-### 3.1 Contribute to Frontend with Docker installation of SigNoz
+Also, have a look at [Frontend README.md](https://github.com/SigNoz/signoz/blob/develop/frontend/README.md) sections for more info on how to setup SigNoz frontend locally (with and without Docker).
+
+## 3.1 Contribute to Frontend with Docker installation of SigNoz
 
 - Clone the SigNoz repository and cd into signoz directory,
   ```
   git clone https://github.com/SigNoz/signoz.git && cd signoz
   ```
 - Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
+
+![develop-frontend](https://user-images.githubusercontent.com/52788043/179009217-6692616b-17dc-4d27-b587-9d007098d739.jpeg)
+
+
 - run `cd deploy` to move to deploy directory,
 - Install signoz locally **without** the frontend,
     - Add / Uncomment the below configuration to query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L47)
-    ```docker
+    ```
     ports:
       - "8080:8080"
     ```
+<img width="869" alt="query service" src="https://user-images.githubusercontent.com/52788043/179010251-8489be31-04ca-42f8-b30d-ef0bb6accb6b.png">    
     
   - Next run,
     ```
     sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d
     ```
-- `cd ../frontend` and change baseURL to `http://localhost:8080` in file [`src/constants/env.ts`](https://github.com/SigNoz/signoz/blob/develop/frontend/src/constants/env.ts)
+- `cd ../frontend` and change baseURL in file [`frontend/src/constants/env.ts#L2`](https://github.com/SigNoz/signoz/blob/develop/frontend/src/constants/env.ts#L2) and for that, you need to create a `.env` file in the `frontend` directory with the following environment variable (`FRONTEND_API_ENDPOINT`) matching your configuration.
+
+    If you have backend api exposed via frontend nginx:
+    ```
+    FRONTEND_API_ENDPOINT=http://localhost:3301
+    ```
+    If not:
+    ```
+    FRONTEND_API_ENDPOINT=http://localhost:8080
+    ```
+
 - Next, 
   ```
   yarn install
@@ -166,7 +190,7 @@ The Maintainers / Contributors who will change Line Numbers of `Frontend` & `Que
 
  **[`^top^`](#)**
 
-### 3.2 Contribute to Frontend without installing SigNoz backend
+## 3.2 Contribute to Frontend without installing SigNoz backend
 
 If you don't want to install the SigNoz backend just for doing frontend development, we can provide you with test environments that you can use as the backend. 
 
@@ -193,27 +217,27 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi
 
 **Need to Update:** [**https://github.com/SigNoz/signoz/tree/develop/pkg/query-service**](https://github.com/SigNoz/signoz/tree/develop/pkg/query-service)
 
-### 4.1 To run ClickHouse setup (recommended for local development)
+## 4.1 To run ClickHouse setup (recommended for local development)
 
 - Clone the SigNoz repository and cd into signoz directory,
-```
-git clone https://github.com/SigNoz/signoz.git && cd signoz
-```
+    ```
+    git clone https://github.com/SigNoz/signoz.git && cd signoz
+    ```
 - run `sudo make dev-setup` to configure local setup to run query-service,
 - Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
 - Comment out `query-service` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L41`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L41)
 - add below configuration to `clickhouse` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
   ```
-  expose:
-    - 9000
   ports:
     - 9001:9000
   ```
 
 - run `cd pkg/query-service/` to move to `query-service` directory,
-- Open [`./constants/constants.go#L38`,](https://github.com/SigNoz/signoz/blob/develop/pkg/query-service/constants/constants.go#L38)
-    - Replace ```const RELATIONAL_DATASOURCE_PATH = "/var/lib/signoz/signoz.db"``` \
-        with →  ```const RELATIONAL_DATASOURCE_PATH = "./signoz.db".```
+- Then, you need to create a `.env` file with the following environment variable 
+    ```
+    SIGNOZ_LOCAL_DB_PATH="./signoz.db"
+    ```
+to set your local environment with the right `RELATIONAL_DATASOURCE_PATH` as mentioned in [`./constants/constants.go#L38`,](https://github.com/SigNoz/signoz/blob/develop/pkg/query-service/constants/constants.go#L38)
 
 - Now, install SigNoz locally **without** the `frontend` and `query-service`,
   - If you are using `x86_64` processors (All Intel/AMD processors) run `sudo make run-x86`
@@ -223,6 +247,29 @@ git clone https://github.com/SigNoz/signoz.git && cd signoz
 ```
 ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse go run main.go
 ```
+
+#### Build and Run locally
+```
+cd pkg/query-service
+go build -o build/query-service main.go
+ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse build/query-service
+```
+
+#### Docker Images
+The docker images of query-service is available at https://hub.docker.com/r/signoz/query-service
+
+```
+docker pull signoz/query-service
+```
+
+```
+docker pull signoz/query-service:latest
+```
+
+```
+docker pull signoz/query-service:develop
+```
+
 ### Important Note:
 The Maintainers / Contributors who will change Line Numbers of `Frontend` & `Query-Section`, please update line numbers in [`/.scripts/commentLinesForSetup.sh`](https://github.com/SigNoz/signoz/blob/develop/.scripts/commentLinesForSetup.sh)
 
@@ -248,12 +295,12 @@ Click the button below. A workspace with all required environments will be creat
 
 **Need to Update: [https://github.com/SigNoz/charts](https://github.com/SigNoz/charts).**
 
-### 5.1 To run helm chart for local development
+## 5.1 To run helm chart for local development
 
 - Clone the SigNoz repository and cd into charts directory,
-```
-git clone https://github.com/SigNoz/charts.git && cd charts
-``` 
+    ```
+    git clone https://github.com/SigNoz/charts.git && cd charts
+    ``` 
 - It is recommended to use lightweight kubernetes (k8s) cluster for local development:
   - [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
   - [k3d](https://k3d.io/#installation)
@@ -261,9 +308,9 @@ git clone https://github.com/SigNoz/charts.git && cd charts
 - create a k8s cluster and make sure `kubectl` points to the locally created k8s cluster,
 - run `make dev-install` to install SigNoz chart with `my-release` release name in `platform` namespace,
 - next run,
-```
-kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301
-``` 
+    ```
+    kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301
+    ``` 
 to make SigNoz UI available at [localhost:3301](http://localhost:3301)
 
 **5.1.1 To install the HotROD sample app:**
@@ -300,7 +347,7 @@ curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-del
  
 ---
 
-## Other ways to contribute
+## Other Ways to Contribute
 
 There are many other ways to get involved with the community and to participate in this project:
 
@@ -315,6 +362,6 @@ There are many other ways to get involved with the community and to participate
 
 By contributing to SigNoz, you agree that your contributions will be licensed under its MIT license.
 
-Again, feel free to ping us on `#contributing` or `#contributing-frontend` on our slack community if you need any help on this :)
+Again, Feel free to ping us on [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [`#contributing-frontend`](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :)
 
 Thank You!

From 4ad79bee1855909d12c4817007d1052614e13a9b Mon Sep 17 00:00:00 2001
From: Priyansh Khodiyar <prik2two@gmail.com>
Date: Thu, 14 Jul 2022 22:51:51 +0530
Subject: [PATCH 15/16] add images

---
 CONTRIBUTING.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4bb6509924..cff1047baf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -225,12 +225,17 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi
     ```
 - run `sudo make dev-setup` to configure local setup to run query-service,
 - Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
+<img width="982" alt="develop-frontend" src="https://user-images.githubusercontent.com/52788043/179043977-012be8b0-a2ed-40d1-b2e6-2ab72d7989c0.png">
+
 - Comment out `query-service` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L41`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L41)
+<img width="1068" alt="Screenshot 2022-07-14 at 22 48 07" src="https://user-images.githubusercontent.com/52788043/179044151-a65ba571-db0b-4a16-b64b-ca3fadcf3af0.png">
+
 - add below configuration to `clickhouse` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
   ```
   ports:
     - 9001:9000
   ```
+<img width="1013" alt="Screenshot 2022-07-14 at 22 50 37" src="https://user-images.githubusercontent.com/52788043/179044544-a293d3bc-4c4f-49ea-a276-505a381de67d.png">
 
 - run `cd pkg/query-service/` to move to `query-service` directory,
 - Then, you need to create a `.env` file with the following environment variable 

From 964b819f20df44a15972266f3b3be87525a91e73 Mon Sep 17 00:00:00 2001
From: Ankit Anand <83692067+ankit01-oss@users.noreply.github.com>
Date: Fri, 15 Jul 2022 13:38:39 +0530
Subject: [PATCH 16/16] Update CONTRIBUTING.md (#1)

---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cff1047baf..80e07b7522 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ Please read through this document before submitting any issues or pull requests
 ## Finding contributions to work on 💬
 
 Looking at the existing issues is a great way to find something to contribute on. 
-Also, have a look at these [good first issues labels](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start with.
+Also, have a look at these [good first issues label](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start with.
 
 
 ## Sections: