Enhance README for new user clarity #3099
Open
Conversation
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
Added a note for new users to improve readability. Signed-off-by: Dipanshu Garg <dipgarg0011@gmail.com>
dipgarg0011
requested review from
1sonofqiu,
Gezi-lzq,
superhx and
woshigaopp
as code owners
|
|
Contributor
|
Thank you for your contribution. However, we already have a similar issue here, and give some more details for the precondition would be better. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Hi team 👋,
This PR includes a few small improvements to the README to make it more friendly for first-time users:
Added a beginner tip explaining where new users should start
Improved clarity in the “Get Started” section
Added a small note to help new developers understand the project
No code or functional changes — documentation only
These minor edits improve readability and help new contributors understand AutoMQ more easily.
Thank you for open-sourcing this great project! 🚀
Happy to contribute more.
— Dipanshu