Request for Development Setup Information to Create a Setup Guide

[RichardChukwu]

Hi Maintainers,

I noticed that the repository currently lacks a development setup guide, which could help streamline onboarding for contributors. I’d like to contribute by creating one, but I’ll need some input from the team to ensure accuracy and completeness.

Here’s the information I’d need:

1. Pre-requisites:

What tools, dependencies, or versions are required (e.g., Erlang/OTP versions, build tools)? - This exists via the README though, but are there specific installation instructions or links to follow?

2. Setting Up Locally:

-Steps to clone and build the project.
-Any configuration or environment variables that need to be set.
-Expected output after setup is successful.

3. Running Tests:

-How to run tests locally.
-Details on testing frameworks used (e.g., unit, integration).
-Any code coverage expectations or reporting tools.
-Development Workflow:

4. Guidelines for creating branches, writing commit messages, or submitting PRs.
   -Any linters, formatters, or coding standards to follow.

5. Further Help
   -Provide links to additional documentation or slack channel for contributors seeking more guidance.

If there are any additional points specific to this repo, please share them as well!

Why This Matters:

Improving the setup guide will lower the barrier for first-time contributors, streamline the onboarding process, and make it easier for developers to contribute effectively to the project. A clear and detailed guide also reduces confusion and support requests, ultimately enhancing the project's community engagement.