Improve Contributor Setup Guide #514
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request standardizes the setup guide for the opentelemetry-cpp-contrib repository using the proposed template. (fixes #513 )
This is an initial draft and includes placeholder sections marked as "TBD" where further information is needed.
Key changes include:
Introduction: Added a warm, welcoming message to contributors and a brief overview of the repository's purpose within the OpenTelemetry ecosystem.
Prerequisites: Listed the required tools and software versions for working on the project.
Workflow: Outlined guidelines for using feature branches, following the OpenTelemetry C++ SDK contributing guidelines, and writing clear commit messages.
Build and run code examples: TBD
Testing: Describe the testing frameworks used and how to execute the full test suite (TBD)
Contributing Rules: Summarized the coding standards, test requirements, and CLA signing process.
Pull Requests: Expanded the guidance for sending, receiving feedback on, and getting PRs merged.
Further Help: Directed contributors to the OpenTelemetry C/C++ community resources for additional assistance.
Next Steps:
Contributors and maintainers are encouraged to help fill in the "TBD" sections with accurate and specific details for this repository. Feedback and suggestions are highly welcomed!
This update aims to make it easier for contributors to get started with the project and follow best practices while contributing.
Please review and let me know if you have any suggestions or feedback.