docs: add beginner-friendly contributor setup guide#3237
docs: add beginner-friendly contributor setup guide#3237felipeofdev-ai wants to merge 1 commit intoAutoMQ:mainfrom
Conversation
lobsangshakya
left a comment
There was a problem hiding this comment.
Great Work!
Small suggestion: the port verification command (lsof -i) is Unix-specific.
It might help first-time contributors if we add equivalent commands for macOS and Windows, or mention that this step is platform-dependent.
|
Question: does the Docker Compose setup always create the automq_net network with this exact name? If not, we could mention how to confirm the network via docker network ls to avoid confusion. |
|
Compared to the existing CONTRIBUTING_GUIDE.md, could you explain why a separate file is necessary? The existing guide already covers Docker setup, build instructions, contribution workflow, and community channels. What specific gaps does this new guide address that couldn't be resolved by improving the existing documentation? |
Summary
This PR adds a comprehensive local setup guide for new contributors, addressing issue #3105.
The guide was written from the perspective of a first-time contributor who completed the full onboarding process and documented every friction point encountered along the way.
What's included
Motivation
Issue #3105 identified that new contributors lack a single, clear entry point for getting productive locally. This guide eliminates that friction by consolidating all setup steps, commands, and context in one place.
Closes #3105