Create a Setup Guide #825
Open
Create a Setup Guide #825
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
|
Thanks for working on adding this! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #825 +/- ##
=======================================
Coverage 17.32% 17.32%
=======================================
Files 24 24
Lines 710 710
=======================================
Hits 123 123
Misses 587 587
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
tsloughter
requested changes
Jan 25, 2025
Co-authored-by: Tristan Sloughter <[email protected]>
Co-authored-by: Tristan Sloughter <[email protected]>
|
All changes resolved @tsloughter |
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 introduces a basic structure for a Contributor Setup Guide to the repository, addressing the need for better onboarding documentation for new contributors. (fixes #824)
The file includes placeholders (TBD) where additional information is required from maintainers or other team members.
The guide covers the following sections:
1. Introduction
-Welcome message to contributors.
-Encouragement to join the community and contribute to the repository.
2. Pre-requisites
-Tools and dependencies required to work with the repository
3. Local Run/Build
-Placeholder for steps on setting up and running the project locally.
-Commands for building and starting the application (TBD).
4. Testing
-Placeholder for details on running the test suite and interpreting results.
-Placeholder for types of tests (e.g., unit, integration) and testing frameworks used (TBD).
5. Further Help
-Communication platforms (Slack, forums, etc.) and documentation references (TBD).
Motivation:
The absence of a setup guide makes it difficult for contributors to onboard effectively. This PR sets the groundwork for a comprehensive guide, enabling maintainers to contribute essential details. Once complete, this document will serve as a critical resource for future contributors following a consistent pattern across other OTel repos.