-
Notifications
You must be signed in to change notification settings - Fork 2
Add Local dev env setup for WP #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a local development environment setup for the project using WP's wp-env to streamline contributor onboarding.
- Adds documentation in the README.md to guide contributors through setting up the local WP environment.
- Updates CHANGELOG.md to highlight the new WP local dev environment feature.
Reviewed Changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Added detailed contribution guidelines and setup steps. |
| CHANGELOG.md | Updated changelog to include the new local dev environment feature. |
Files not reviewed (4)
- .deployignore: Language not supported
- .wp-env.json: Language not supported
- package.json: Language not supported
- readme.txt: Language not supported
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a local development environment setup for WP by updating documentation and changelog entries. It provides clear instructions for contributors to quickly spin up the project's WP instance locally.
- Added detailed contribution instructions in the README.md for running the local WP environment.
- Updated the CHANGELOG.md with a new entry describing the feature.
Reviewed Changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Added contribution instructions and local WP env setup commands |
| CHANGELOG.md | Added changelog entry for the new WP local dev env feature |
Files not reviewed (4)
- .deployignore: Language not supported
- .wp-env.json: Language not supported
- package.json: Language not supported
- readme.txt: Language not supported
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a local development environment setup for contributors, enabling a standardized process for spinning up a WordPress instance using wp-env. Key changes include:
- Adding a "Contribute" section with prerequisites and launch instructions in the README.
- Updating the CHANGELOG to reflect the new development environment feature.
Reviewed Changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added instructions and guidelines for setting up a local WP environment using Yarn. |
| CHANGELOG.md | Documented the new feature for local development environment setup. |
Files not reviewed (4)
- .deployignore: Language not supported
- .wp-env.json: Language not supported
- package.json: Language not supported
- readme.txt: Language not supported
Comments suppressed due to low confidence (2)
README.md:150
- The instruction references the 'master' branch. Confirm if the default branch is still 'master' or update this to 'main' for consistency.
raise a PR (Pull Request) against the `master` branch.
README.md:163
- The PR description mentions using 'yarn wp-env start' but the README uses 'yarn start'. Please ensure the command is consistent to avoid confusion.
yarn start
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a local development environment setup for contributors using WP’s wp-env and updates the documentation accordingly.
- Adds a "Contribute" section to README.md with instructions to run the local WP instance.
- Updates CHANGELOG.md with a new entry documenting the local dev environment feature.
Reviewed Changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added contributor instructions to set up a local WP environment. |
| CHANGELOG.md | Documented the new local development environment feature. |
Files not reviewed (4)
- .deployignore: Language not supported
- .wp-env.json: Language not supported
- package.json: Language not supported
- readme.txt: Language not supported
Comments suppressed due to low confidence (2)
README.md:150
- [nitpick] Consider updating 'master' to 'main' if 'main' is now the default branch to avoid confusion for contributors.
raise a PR (Pull Request) against the `master` branch.
README.md:169
- [nitpick] Consider formatting the URL as plain text or a markdown link, rather than using a bash code block, to clearly indicate that it is a URL and not a command.
http://sql.localhost:5467
This PR resolves this issue.
Description / Background Context
At the moment, contributors have to use their own methods of setting up this repo. We need to provide a consistent way for users to spin up this project's repo and contribute quickly perhaps using WP's
wp-envso that users can now spin up their local instance by running:This PR implements this correctly.
Testing Instructions
rm -rf node_modules && yarn start.wp-envinstance ready for the user.http://sql.localhost:5467