docs: add admin screen performance PR testing checklist#509
Open
faisalahammad wants to merge 1 commit into
Open
docs: add admin screen performance PR testing checklist#509faisalahammad wants to merge 1 commit into
faisalahammad wants to merge 1 commit into
Conversation
Add a performance PR testing checklist for admin screens at docs/contributing/admin-performance-testing.md, linked from the contributing guide and the PR template. Gives contributors a copy-pasteable smoke process for the heavy SCF admin screens, since the project has no dedicated performance harness. Regenerates docs/bin/manifest.json so the new doc is discovered. Fixes WordPress#498
|
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @tapheret2. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
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 a performance PR testing checklist for admin screens to the contributing docs, so contributors have a copy-pasteable smoke process for the heavy SCF admin screens before opening a PR. The project has no dedicated performance harness, so the checklist walks through manual browser checks plus reuse of the existing Playwright specs as a regression baseline.
Fixes #498
Changes
docs/contributing/admin-performance-testing.md (new)
The checklist itself. Covers when to run it, prerequisites, the screens most likely to regress (Field Groups list, Field Group editor, UI Options Pages list/editor, runtime options page, Tools), browser DevTools checks with JS console and PHP debug.log separated, a Playwright smoke block reusing existing e2e specs, and an optional ad-hoc profiling section using the browser's built-in profiler. Three copy-pasteable
shblocks.docs/contributing/index.md
Before:
After:
Why: Discoverability. Contributors land on the index guide first, so the checklist is one click from the entry point.
.github/pull_request_template.md
Before:
<!-- Thanks for contributing ... Contributing Guidelines link -->After:
Why: Surfaces the checklist at PR creation time, exactly when a contributor is deciding what to test. Kept as an HTML comment so it does not change the rendered PR body.
docs/bin/manifest.json
Before: no entry for the new doc.
After:
{ "contributing/admin-performance-testing": { "slug": "admin-performance-testing", "parent": "contributing", "markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/admin-performance-testing.md" } }Why: The manifest is auto-generated and committed (see #385 for the same pattern with releases.md). Regenerated via
php docs/bin/generate-manifest.phpso the new doc is discovered.Testing
Test 1: markdown lint passes on the new doc
npm run lint:mdResult: no output, exit 0.
Test 2: internal links resolve
docs/contributing/index.mdand click the new link.docs/contributing/admin-performance-testing.mdexists..github/pull_request_template.mdand confirm the HTML-comment URL points to the new doc ontrunk.Result: all three links resolve.
Test 3: copy-pasteable blocks
Result: the
shblocks are runnable as-is (no placeholders that break copy-paste).Checklist
docs/contributing/documentation.md