Missing info in Contributor Guide

[RichardChukwu]

This is part of open-telemetry/sig-contributor-experience#31

The goal is to clarify Run/build prerequisites, testing and address common build issues to make it easier for first-time contributors to get started with opentelemetry-erlang.

I'd like to verify these info before adding to the proposed PR for fixing:

Local Run/Build

Setting Up and Running the Project Locally

To run the project locally, follow these steps:

Start required services:

docker compose up -d

Set up Erlang/OTP and Rebar3 and Verify setup(Ensure you have the correct versions as specified in the Pre-requisites):

Run the compilation step to check for errors:

rebar3 compile

Testing

To execute tests, use the following commands:

Unit Tests (EUnit):

rebar3 eunit --cover

Integration and Functional Tests (Common Test):

rebar3 ct --cover

Troubleshooting Guide

Interpreting Test Results

• Test results are automatically reported using mikepenz/action-junit-report@v5.

• Failures in EUnit and Common Test should be reviewed for failing assertions.

Debugging Common Failures

• Test Failures: Check the test logs in _build/test/logs/.

• Compilation Issues: Ensure correct OTP and Rebar3 versions are installed.

• Dialyzer Warnings: Review rebar.lock and ensure rebar3 compile completes successfully.

Feedback are welcome to ensure all info here are correct

Ongoing PR: #825

CC: @tsloughter