Repository navigation
Enhance CONTRIBUTING.md with local setup details - #64
Merged
Merged
Conversation
Added instructions for local setup and testing. Co-authored-by: Darin Kotter <darin.kotter@gmail.com> Co-authored-by: Blake Bertuccelli-Booth <46652+bbertucc@users.noreply.github.com>
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
karmatosed
approved these changes
Oct 31, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Closes #58.
This pull request adds new instructions to the
CONTRIBUTING.mdfile to clarify the local setup and testing steps for contributors. The update helps ensure that new developers understand how to properly install dependencies and prepare the environment before running tests or building assets.Local setup and testing instructions:
composer installto install and activate the plugin.npm i && npm run buildfor future asset builds, and clarified that currently onlynpm iis needed for local testing.Why?
The existing docs don't provide details on getting set up locally for testing or contributing.
How?
Docs added thanks to @dkotter input in #58 (comment).
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast
Test using WordPress Playground
The changes in this pull request can be previewed and tested using this WordPress Playground instance:
Click here to test this pull request.