Skip to content

Conversation

@Sahildavkhar
Copy link

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

@changeset-bot
Copy link

changeset-bot bot commented Oct 6, 2025

⚠️ No Changeset found

Latest commit: 3989bce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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.

1 participant