diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5d8432c48..33e4d392eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,7 +72,7 @@ cd .\src\adservice\ all the images will be build): ```shell -docker compose up +docker compose up -d ``` ### Verify the Webstore & the Telemetry @@ -83,6 +83,8 @@ Once the images are built and containers are started you can access: - Jaeger: - Prometheus: - Grafana: +- Feature Flags UI: +- Load Generator UI: ## Create Your First Pull Request @@ -100,7 +102,7 @@ git clone https://github.com/open-telemetry/opentelemetry-demo.git Navigate to the repo root: ```sh -cd opentelemetry--demo +cd opentelemetry-demo ``` Add your fork as an origin: @@ -113,8 +115,12 @@ Check out a new branch, make modifications and push the branch to your fork: ```sh $ git checkout -b feature -# edit files -$ git commit +# change files +# Test your changes locally. +$ docker compose up -d --build +# Go to Webstore, Jaeger or docker container logs etc. as appropriate to make sure your changes are working correctly. +$ git add my/changed/files +$ git commit -m "short discription of the change" $ git push fork feature ```