Improve README with Local Setup and Contribution Guide #185
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.
This PR enhances the main README.md file by adding clear local setup instructions, WordPress backend connection steps, and links to documentation for contributors. It improves developer onboarding and helps new contributors quickly get started with SnapWP.
Changes Made
Added installation and local development steps (npm install, npm run dev).
Included setup instructions for connecting to WPGraphQL.
Improved readability and section formatting with emojis and tables.
Added a detailed “Development & Contributing” section.
Clarified available SnapWP packages and their roles.
Included final contribution steps for committing and opening PRs.
Testing
Verified that the local development setup runs successfully with:
npm install
npm run dev
Ensured all package links and internal docs references work correctly.
Here’s a quick preview of the improved structure:
Local setup guide 🧑💻
WordPress integration instructions 🔗
Package overview table 📦
Contribution guide 🧩
Community & hiring section 💬
Acknowledgements
Special thanks to the rtCamp team for open-sourcing SnapWP and maintaining a clean modular structure that makes contribution easy.
PR Type
Documentation improvement