Skip to content

Docs/improve contributing guide#3238

Open
felipeofdev-ai wants to merge 3 commits intoAutoMQ:mainfrom
felipeofdev-ai:docs/improve-contributing-guide
Open

Docs/improve contributing guide#3238
felipeofdev-ai wants to merge 3 commits intoAutoMQ:mainfrom
felipeofdev-ai:docs/improve-contributing-guide

Conversation

@felipeofdev-ai
Copy link
Copy Markdown

Summary

Improves the existing CONTRIBUTING_GUIDE.md by adding sections that are
currently missing for first-time contributors, as suggested by @KaimingWan in issue #3105.

What was added

  • Local Environment Setup — prerequisites with platform-specific port verification (macOS/Linux/Windows), Docker Compose startup, network confirmation, producer test, teardown
  • Building AutoMQ — Gradle wrapper usage, full build, per-module tests
  • Key Modules — table of the main modules with descriptions
  • Troubleshooting — common issues and fixes
  • Commands Cheat Sheet — quick reference for all common operations

What was NOT changed

No existing content was removed or rewritten. Purely additive.

Related to #3105

…ibutor-setup-guide

docs: add beginner-friendly contributor setup guide
…oubleshooting and cheat sheet

Signed-off-by: Felipe Fernandes — Systems & AI Engineer <felipe.of.dev@gmail.com>
@Gezi-lzq
Copy link
Copy Markdown
Contributor

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?
Having two similar guides may confuse new contributors and increase maintenance overhead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants