docs: add contributing guide and partner plugin testing guide - #186
Open
glaubersilva wants to merge 1 commit into
Open
docs: add contributing guide and partner plugin testing guide#186glaubersilva wants to merge 1 commit into
glaubersilva wants to merge 1 commit into
Conversation
- Add CONTRIBUTING.md with the harbor-dev-tools quick start, prerequisites, documentation index, and release/PR expectations - Add docs/guides/partner-plugin-testing.md covering how to test local Harbor changes inside a real partner plugin via a Composer path repository (native PHP, Lando/Docker, and wp-env setups) - Update docs/guides/testing.md: replace the outdated sample-plugin fixture workflow with harbor-dev-tools, document fixture keys and admin URLs - Link the new docs from README.md and docs/harbor.md - Add words used by the new docs to .cspell.json
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.
Summary
Adds developer documentation split out from the declined rebranding PR: #175
Despite the declination, the contributor workflow and partner-plugin testing guides are still valuable on their own. This PR contains documentation only: no PHP/JS code, no branding changes, no built assets.
New docs
CONTRIBUTING.md— contributor quick start:composer harbor:watch+npm run build/startfor frontend work)build/handling,composer release:prep)docs/guides/partner-plugin-testing.md— advanced guide: testing local Harbor changes inside a real partner plugin via a Composer path repository:"stellarwp/harbor": "*@dev"and"symlink": falseare requiredcomposer updateonce,composer installper iteration) and whycomposer straussalone failssafe.directorysteps when Harbor lives outside the site rootUpdated docs
docs/guides/testing.md— replaces the outdated sample-plugin fixture workflow with harbor-dev-tools: layout, fixture key guidance (lwsw-unified-basic-2026for the Software Manager UI), admin URLs, and the current fixture file resolution order (vendor-prefixed/stellarwp/harbor/tests/_data/)README.md— adds a Contributing section and links the new partner-plugin testing guidedocs/harbor.md— adds the new guide to the documentation table.cspell.json— adds words used by the new docs (lando,mamp,wamp,docroot,appserver,lightningcss)Notes for reviewers
mainas-is: all references tied to the rebranding (e.g. thenexcess-software-manageradmin slug) were removed — the admin URL table intesting.mdpoints to the currentlw-software-managerslug only.markdownlintandcspellpass on all changed files.Test plan
npm run lint:mdandbun run check:spellingpassCONTRIBUTING.mdquick start on a clean checkout (harbor-dev-tools +composer harbor:watch)docs/harbor.md,CONTRIBUTING.md, and the guides