Skip to content

Conversation

@badasswp
Copy link
Owner

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-env so that users can now spin up their local instance by running:

yarn wp-env start

This PR implements this correctly.

Testing Instructions

  1. Pull PR to local.
  2. Build correctly by running rm -rf node_modules && yarn start.
  3. The repo should now build and boot up the wp-env instance ready for the user.
  4. User should be able to access the site at: http://sql.localhost:5467

@badasswp badasswp added documentation Improvements or additions to documentation enhancement New feature or request chore Task to be done labels Mar 28, 2025
@badasswp badasswp requested a review from Copilot March 28, 2025 08:23
@badasswp badasswp self-assigned this Mar 28, 2025
Copy link
Contributor

Copilot AI left a 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

@badasswp badasswp requested a review from Copilot March 28, 2025 08:26
Copy link
Contributor

Copilot AI left a 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>
@badasswp badasswp requested a review from Copilot March 28, 2025 08:27
Copy link
Contributor

Copilot AI left a 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

@badasswp badasswp requested a review from Copilot March 28, 2025 08:29
Copy link
Contributor

Copilot AI left a 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

@badasswp badasswp merged commit 144dea6 into release-1.3.1 Mar 28, 2025
1 check passed
@badasswp badasswp linked an issue Mar 28, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Task to be done documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Local dev env setup for WP

2 participants