docs: add beginner-friendly local setup guide#3123
Closed
adhraj12 wants to merge 1 commit intoAutoMQ:mainfrom
Closed
docs: add beginner-friendly local setup guide#3123adhraj12 wants to merge 1 commit intoAutoMQ:mainfrom
adhraj12 wants to merge 1 commit intoAutoMQ:mainfrom
Conversation
e61b016 to
c1c5a85
Compare
Contributor
|
@adhraj12 Hi,thank you for your contribution, we have some suggestions. Regarding deployment, the beginning of the Readme already provides instructions for Docker startup and other relevant reference methods. The content about local setup actually falls more into the scope of how to debug locally and contribute code. Could you help optimize the existing CONTRIBUTING_GUIDE.md content instead of creating a new file? |
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.
Fixes #3105
Motivation
As a new contributor, I found that having a dedicated local setup guide clarifies the prerequisites and build steps.
Modifications
docs/local_setup.mdto provide a clear entry point for new developers.-Dfile.encoding=UTF-8), which I discovered and verified during my own setup.Verification
Committer Checklist