Repository navigation
docs(contributing): improve Angular testing documentation and fix broken contributing link - #31250
Merged
thetaPC merged 5 commits intoAug 3, 2026
Merged
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
…gular testing Co-authored-by: Maria Hutt <thetaPC@users.noreply.github.com>
Based on feedback in code review
thetaPC
requested changes
Jul 31, 2026
"Refer to" instead of "see" for better inclusivity Co-authored-by: Maria Hutt <thetaPC@users.noreply.github.com>
thetaPC
approved these changes
Aug 3, 2026
HappyKnuckles
pushed a commit
to HappyKnuckles/ionic-framework
that referenced
this pull request
Oct 3, 2026
…ken contributing link (ionic-team#31250) Issue number: resolves ionic-team#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.md` resolves to a 404 when viewed from GitHub's **Contributing** tab because the relative path is not resolved correctly. - Broken link: https://github.com/ionic-team/ionic-framework/blob/core/src/utils/test/playwright/docs/README.md - Intended destination: https://github.com/ionic-team/ionic-framework/blob/main/core/src/utils/test/playwright/docs/README.md - The Angular testing guide (`docs/angular/testing.md`) omits several steps that are necessary to successfully test local framework changes, including: - Removing existing `npm link` relationships before starting a new sync cycle. - Building `packages/angular-server`. - Installing Playwright browser dependencies before running Playwright tests for the first time. 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: - Fixes the broken link to the Ionic E2E testing guide in `CONTRIBUTING.md` by using a repository-root-relative path. - Updating `docs/angular/testing.md` to document the complete workflow for syncing local Angular framework changes. - Documents that `packages/angular-server` should be built as part of the local testing workflow. - Documents that contributors should remove previous `npm link` relationships before beginning a new sync cycle. - Clarifies the recommended workflow for syncing local package changes. - Documents the Playwright browser installation step required before running Playwright tests for the first time. ## Does this introduce a breaking change? - [ ] Yes - [x] No ## Other information --------- Co-authored-by: Maria Hutt <thetaPC@users.noreply.github.com>
This branch was successfully deployed
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.
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