You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Pre-requisites:
Clarify tools, versions, and environment setup required before contributing (e.g., Go version, OS compatibility, protoc compiler requirements, etc.).
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.
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).
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.
Further Help:
Provide links to additional documentation or slack channel for contributors seeking more guidance.
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.
The text was updated successfully, but these errors were encountered:
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:
Pre-requisites:
Clarify tools, versions, and environment setup required before contributing (e.g., Go version, OS compatibility, protoc compiler requirements, etc.).
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.
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).
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.
Further Help:
Provide links to additional documentation or slack channel for contributors seeking more guidance.
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.
The text was updated successfully, but these errors were encountered: