Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Contributor Setup Guide #513

Open
RichardChukwu opened this issue Jan 23, 2025 · 0 comments · May be fixed by #514
Open

Improve Contributor Setup Guide #513

RichardChukwu opened this issue Jan 23, 2025 · 0 comments · May be fixed by #514

Comments

@RichardChukwu
Copy link

RichardChukwu commented Jan 23, 2025

The existing setup guide for the opentelemetry-cpp-contrib repository lacks several key sections recommended in the proposed template. Standardizing the guide will improve consistency across OpenTelemetry repositories and provide a better onboarding experience for new contributors.

Suggested Improvements:

  1. Pre-requisites:
    Clarify tools, versions, and environment setup required before contributing (e.g., Go version, OS compatibility, protoc compiler requirements, etc.).

  2. Dependency Installation:
    Provide step-by-step instructions for installing required dependencies, including protoc-gen-go and protoc-gen-go-grpc.
    Detail any additional setup for go.work usage during local development.

  3. Local Run/Build:
    Explain how to run or build the repository locally.
    Include specific commands and expected outcomes (e.g., running the ./proto/generate.sh script or testing the ArrowStreamService gRPC service).

  4. Testing:
    Include a section on how to execute tests locally, with commands and testing frameworks used.
    Clarify whether Docker or any external test dependencies are required.

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

  6. Additional Information:
    Repo specific information not already covered.

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.

I’d be happy to assist with creating a pull request to add these information if they can be provided.

@RichardChukwu RichardChukwu linked a pull request Jan 23, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant