docs: fix minor grammar and wording improvements in README#8136
Open
Starksid007 wants to merge 1 commit intojaegertracing:mainfrom
Open
docs: fix minor grammar and wording improvements in README#8136Starksid007 wants to merge 1 commit intojaegertracing:mainfrom
Starksid007 wants to merge 1 commit intojaegertracing:mainfrom
Conversation
Signed-off-by: Siddharth Kushwaha <siddharthkushwahan@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR that improves README readability by adjusting grammar and wording in a few sentences.
Changes:
- Add missing article (“the”) in CNCF attribution sentence
- Adjust wording around deprecation likelihood (“can” → “may”)
- Rephrase contributor thank-you line for smoother wording
Comments suppressed due to low confidence (1)
README.md:70
- Minor grammar: add a comma after the introductory clause "Since Jaeger uses many components from the OpenTelemetry Collector" to improve readability.
Since Jaeger uses many components from the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/) we try to maintain configuration compatibility between Jaeger releases. Occasionally, configuration options in Jaeger (or in Jaeger v1 CLI flags) may be deprecated due to usability improvements, new functionality, or changes in our dependencies.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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.
Which problem is this PR solving?
This PR fixes minor grammar and wording issues in the documentation to improve readability.
Description of the changes
No functional changes are introduced.
How was this change tested?
Documentation-only change. No tests required.