Add Contributing guide to repos

[maryliag]

Add Contributing guide to repos, following the template below:

Introduction (Welcome message to Contributors)

• A warm, inviting message to make contributors feel welcome.
• Brief overview of the repository’s purpose and how it fits within the larger project (e.g., OpenTelemetry ecosystem).
• A statement of appreciation for contributions, regardless of size or scope.
• Encouragement to ask questions and seek help in the community.

Pre-requisites

• List of tools, languages, and software required to work with the repository (e.g., programming languages, specific frameworks).
• Any version requirements or compatibility notes (e.g., "PHP 8.1 or higher").
• Mention additional platform-specific notes (e.g., macOS, Windows, Linux differences).

Workflow

• Any specific workflows unique to the repository, such as using specific tools (e.g., Makefile, GitHub Actions).
• Explanation of PR title conventions
• Explanation of branch naming conventions and commit message formatting (if there is any).

Local Run/Build

• How to set up and run the project locally.
• Commands for building the project and starting the application.
• Any important files that need to be created or modified (e.g., copying .env.dist to .env).
• Notes about expected outputs or verification steps to confirm the setup is successful.

Testing

• How to run the test suite for the repository.
• Explanation of different types of tests (e.g., unit, integration, or functional).
• Tools and frameworks used for testing (e.g., PHPUnit, Jest, or pytest).
• How to interpret test results and resolve common test failures.
• Mention code coverage expectations or reporting tools if applicable.

Contributing Rules

• Adhering to coding standards.
• Writing meaningful commit messages.
• Including tests for new features or bug fixes.
• Reference any community standards or style guides.
• Instructions for signing a Contributor License Agreement (CLA), if required.
• Links to tags like good first issue or help wanted.

Further Help

• Details on where contributors can seek assistance:
• Links to Slack, Discord, or other communication platforms.
• GitHub Discussions or forums.
• Documentation references or FAQs.
• Contact information for maintainers or SIG members.

Troubleshooting Guide

• Common errors during setup, build, or tests and their resolutions.
• Platform-specific issues (e.g., Docker daemon errors on Windows).
• Example error messages with potential fixes.
• Tips for debugging or where to find logs (e.g., Docker logs, build logs).

Additional Information (Repo-Specific Info)
Any unique details specific to the repository, such as:
Details about automation processes (e.g., CI/CD pipelines).
Notes on optional tasks, like generating documentation or metrics.

Suggestions to Enhance the Guide

• Add visuals or screenshots where possible (e.g., examples of successful build/test outputs).
• Provide links to examples of PRs that follow best practices.
• Highlight beginner-friendly tasks to lower the barrier to entry.
• Create a quick-start section for contributors who want to dive in with minimal setup.

[RichardChukwu]

• https://github.com/open-telemetry/otel-arrow - Improve Contributor Setup Guide otel-arrow#282

• https://github.com/open-telemetry/build-tools - requires separate guides for each build tool

• https://github.com/open-telemetry/opentelemetry-collector - no new info needed

• https://github.com/open-telemetry/opentelemetry-collector-releases - Improve contributor guide opentelemetry-collector-releases#816

• https://github.com/open-telemetry/opentelemetry-configuration -

• https://github.com/open-telemetry/opentelemetry-cpp - Proposed Pre-requisite info already included

• https://github.com/open-telemetry/opentelemetry-cpp-contrib - Improve Contributor Setup Guide  opentelemetry-cpp-contrib#514

• https://github.com/open-telemetry/opentelemetry-demo - Improve contributor guide opentelemetry-demo#2010

• https://github.com/open-telemetry/opentelemetry-dotnet - no new info needed

• https://github.com/open-telemetry/opentelemetry-ebpf-profiler - Improve contributor guide opentelemetry-ebpf-profiler#349

• https://github.com/open-telemetry/opentelemetry-erlang - Create a Setup Guide  opentelemetry-erlang#825

• https://github.com/open-telemetry/opentelemetry-go-build-tools -

• https://github.com/open-telemetry/opentelemetry-go-contrib - no new info needed

• https://github.com/open-telemetry/opentelemetry-go - no new info needed

• https://github.com/open-telemetry/opentelemetry-go-instrumentation - no new info needed

• https://github.com/open-telemetry/opentelemetry-helm-charts - Improve Contributor Guide opentelemetry-helm-charts#1511

• https://github.com/open-telemetry/opentelemetry.io -no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-java-contrib - Improve Contributing Guide opentelemetry-java-contrib#1680

• https://github.com/open-telemetry/opentelemetry-java-examples - same for java repo

• https://github.com/open-telemetry/opentelemetry-java - no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-js - all previous recommendations already added to doc

• https://github.com/open-telemetry/opentelemetry-lambda - Improve Contributor Guide opentelemetry-lambda#1705

• https://github.com/open-telemetry/opentelemetry-network-build-tools - no new info needed

• https://github.com/open-telemetry/opamp-go - Improve contributor guide opamp-go#353

• https://github.com/open-telemetry/opentelemetry-operator - no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-php - Update development guide to contributing guide opentelemetry-php#1513

• https://github.com/open-telemetry/opentelemetry-proto-java - Improve contributing guide opentelemetry-proto-java#26

• https://github.com/open-telemetry/opentelemetry-proto - Update CONTRIBUTING.md opentelemetry-proto#627

• https://github.com/open-telemetry/opentelemetry-python - no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-ruby - no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-ruby-contrib - no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-rust-contrib - no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-rust - no new info needed, has good structure too

• https://github.com/open-telemetry/opentelemetry-sandbox-web-js - repo status inactive

• https://github.com/open-telemetry/semantic-conventions - no new info needed, has good structure too

• https://github.com/open-telemetry/semantic-conventions-java - same as that of java repo, required link to that doc added already

• https://github.com/open-telemetry/opentelemetry-swift - no new info needed

• https://github.com/open-telemetry/weaver - info required already stated in the README