docs(contributing): improve Angular testing documentation and fix broken contributing link - #31250
Open
Zac-Smucker-Bryan wants to merge 4 commits into
Open
docs(contributing): improve Angular testing documentation and fix broken contributing link#31250Zac-Smucker-Bryan wants to merge 4 commits into
Zac-Smucker-Bryan wants to merge 4 commits into
Conversation
Add pre-step to use npm unlink * to remove problematic links. Add step to build angular server as part of the steps to sync all changes. Add clarification that playwright install is necessary for first time testing changes.
|
@Zac-Smucker-Bryan is attempting to deploy a commit to the Ionic Team on Vercel. A member of the Team first needs to authorize it. |
Zac-Smucker-Bryan
marked this pull request as ready for review
June 26, 2026 19:40
Zac-Smucker-Bryan
changed the title
gnbm
changed the title
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
brandyscarney
changed the title
thetaPC
requested changes
Jul 30, 2026
| 4. The `preview/` directory is used in the documentation as a demo. Only update this test if there is a bug in the test or if the API has a change that hasn't been updated in the test. | ||
|
|
||
| See [Ionic's E2E testing guide](../core/src/utils/test/playwright/docs/README.md) for information regarding the tools you can use to test Ionic. | ||
| See [Ionic's E2E testing guide](/core/src/utils/test/playwright/docs/README.md) for information regarding the tools you can use to test Ionic. |
Contributor
There was a problem hiding this comment.
I'm unable to reproduce the 404 error when clicking it from the web. What am I missing so I can validate this change?
Contributor
Author
There was a problem hiding this comment.
Screen.Recording.2026-07-30.at.8.06.59.PM.mov
I get this when I am on the contributing tab, under modifying tests: https://github.com/ionic-team/ionic-framework?tab=contributing-ov-file#modifying-tests, and then click "See Ionic's E2E testing guide for more information..." at first it says error loading the page, but then if you do reload/refresh it says "Cannot find a valid ref in core/src/utils/test/playwright/docs/README.md"
…gular testing Co-authored-by: Maria Hutt <thetaPC@users.noreply.github.com>
Based on feedback in code review
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
2 participants
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.
Issue number: resolves #31251
What is the current behavior?
While working on e2e tests in the angular directory, I encountered a few documentation issues that made the local development workflow more difficult to follow.
The "See Ionic's E2E testing guide" link in
CONTRIBUTING.mdresolves to a 404 when viewed from GitHub's Contributing tab because the relative path is not resolved correctly.The Angular testing guide (
docs/angular/testing.md) omits several steps that are necessary to successfully test local framework changes, including:npm linkrelationships before starting a new sync cycle.packages/angular-server.These omissions made it difficult to reproduce and validate additions to Angular tests I was adding as part of a separate PR.
What is the new behavior?
This PR does the following:
CONTRIBUTING.mdby using a repository-root-relative path.docs/angular/testing.mdto document the complete workflow for syncing local Angular framework changes.packages/angular-servershould be built as part of the local testing workflow.npm linkrelationships before beginning a new sync cycle.Does this introduce a breaking change?
Other information