Improve Contributor Setup Guide #282
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
Improve Contributor Setup Guide
RichardChukwu
requested review from
lquerel,
jmacd,
moh-osman3 and
codeboten
as code owners
jmacd
approved these changes
Jan 22, 2025
Comment on lines
+21
to
+38
| ## Local Run/Build | ||
|
|
||
| ### How to set up and run the project locally | ||
| TBD | ||
|
|
||
| ### Commands for building the project and starting the application. | ||
| TBD | ||
|
|
||
| ## Testing | ||
| -How to run the test suite for the repository. (TBD) | ||
|
|
||
| -Explanation of different types of tests (e.g., unit, integration, or functional). (TBD) | ||
|
|
||
| -Tools and frameworks used for testing (TBD) | ||
|
|
||
| -How to interpret test results and resolve common test failures. (TBD) | ||
|
|
||
| -Mention code coverage expectations or reporting tools if applicable. (TBD) |
There was a problem hiding this comment.
Suggested change
| ## Local Run/Build | |
| ### How to set up and run the project locally | |
| TBD | |
| ### Commands for building the project and starting the application. | |
| TBD | |
| ## Testing | |
| -How to run the test suite for the repository. (TBD) | |
| -Explanation of different types of tests (e.g., unit, integration, or functional). (TBD) | |
| -Tools and frameworks used for testing (TBD) | |
| -How to interpret test results and resolve common test failures. (TBD) | |
| -Mention code coverage expectations or reporting tools if applicable. (TBD) | |
| ## How to set up and run a local OTel-Arrow collector | |
| See [collector/README.md](./collector/README.md) for instructions on running the examples. | |
| See [collector/BUILDING.md](./collector/BUILDING.md) for instructions on building a collector | |
| from local sources. |
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 PR updates the CONTRIBUTING.md file to provide a comprehensive guide for contributors to the OpenTelemetry Protocol with Apache Arrow project. (fixes #281 )
This is an initial draft and includes placeholder sections marked as "TBD" where further information is needed.
Pre-requisites: Detailed installation instructions for required tools like Go, Protocol Buffers, and protoc-gen-go.
Local Setup: Instructions on setting up and building the project locally (TBD sections).
Testing: Guidance on running the test suite, understanding different types of tests, and resolving common failures.
Contribution Guidelines: Best practices for:
-Adhering to coding standards and guidelines.
-Writing clear and meaningful commit messages.
-Including appropriate tests for new features and bug fixes.
Following community standards and style guides.
Instructions for signing the Contributor License Agreement (CLA).
Community Resources: Links to the OpenTelemetry Slack community and additional communication platforms.
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.