Skip to content

docs(forms): adding forms strategy to washing machine workflow - #6584

Open
aramos-adobe wants to merge 5 commits into
mainfrom
aziz/forms-strategy-rfc-washing-machine
Open

docs(forms): adding forms strategy to washing machine workflow#6584
aramos-adobe wants to merge 5 commits into
mainfrom
aziz/forms-strategy-rfc-washing-machine

Conversation

@aramos-adobe

@aramos-adobe aramos-adobe commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Description

Adds contributor-facing documentation for the approved 2nd-gen forms strategy so the decisions are discoverable before form-field migration PRs are opened.

  • New: CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md — the canonical forms strategy, mirroring the existing focus-management-strategy-rfc.md. Covers ElementInternals/FACE form participation (FieldAssociationController), where ARIA roles live (shadow DOM), the label/help/error IDREF model (LabellingController, same-root slots + cross-root element references), a naming table, and the axe-core policy for ElementInternals gaps.
  • Updated: .../02_step-by-step/01_washing-machine-workflow.md — a new "Form participation (form fields only)" subsection in Phase 3 (API), label/help/error + cross-root IDREF guidance in Phase 4 (Accessibility), a Phase 4 axe/CI quality-gate item, a common-problems row, and a forms-strategy cross-link.
  • Updated: .../03_components/README.md — routes form-field migrations to the canonical strategy.
  • Regenerated breadcrumbs/TOC via the contributor-docs nav script; all links in the changed files validate.

Motivation and context

Form-field migration is about to scale, and the forms-strategy decisions previously lived only in a proof-of-concept repo and RFC discussion, not in the contributor docs. This surfaces them at the point migrators need them (Phase 3 and Phase 4 of the washing machine workflow) and gives every form field one canonical reference for form participation, role placement, cross-root labelling, and axe policy.

Content is sourced from the form-strategy proof-of-concept (nikkimk/web-component-form-strategy-demos). Controllers still under an open research decision (ButtonAssociationController, RadioGroupController) are explicitly marked pending research rather than presented as settled.

Related issue(s)

  • fixes SWC-2055

Screenshots (if appropriate)

N/A — Markdown contributor documentation only.

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed the Accessibility Practices for this feature.
  • I have added automated tests to cover my changes. — N/A, documentation only.
  • I have included a well-written changeset if my change needs to be published. — N/A, CONTRIBUTOR-DOCS changes are not published to a package.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

  • New strategy doc and cross-links render correctly

    1. Check out this branch and open CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md.
    2. Confirm §3.1–§3.4, the naming table (§4), open questions, and appendix render with no TODO placeholders.
    3. Expect the pending research rows for button-like and grouped-selection fields to be clearly marked as provisional.
  • Washing machine workflow additions

    1. Open .../02_step-by-step/01_washing-machine-workflow.md.
    2. Confirm the new Phase 3 "Form participation" subsection, the Phase 4 label/help/error step, the Phase 4 axe quality-gate item, and the common-problems row are present and read in context.
    3. Expect the phase framing to match this repo (a11y is Phase 4, styling is Phase 5).
  • Links resolve

    1. From CONTRIBUTOR-DOCS/01_contributor-guides/07_authoring-contributor-docs, run node update-nav.js.
    2. Follow each forms-strategy link from the washing machine doc and the components README.
    3. Expect no new broken links introduced by this PR.

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

Accessibility testing checklist

This PR changes Markdown contributor documentation only. It adds no component, runtime behavior, or focusable UI, so there is no interactive surface to test with a keyboard or screen reader.

  • Keyboard

    1. N/A — no component or focusable UI is added or modified; no interactive examples are introduced.
  • Screen reader

    1. N/A — the docs describe accessibility patterns but ship no interactive UI. Rendered docs pages inherit the Storybook docs shell, which is unchanged by this PR.

@aramos-adobe
aramos-adobe requested a review from a team as a code owner August 5, 2026 19:26
@changeset-bot

changeset-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a9dc2f1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@aramos-adobe aramos-adobe self-assigned this Aug 5, 2026
@aramos-adobe aramos-adobe added Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. gen2 These issues or PRs map to our 2nd generation work to modernizing infrastructure. skip_vrt Skip VRT build; mark UI Tests green without running Chromatic labels Aug 5, 2026
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

📚 Branch Preview Links

🔍 Gen1 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6584

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@coveralls

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 31039458154

Warning

No base build found for commit 3ebd27e on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 96.241%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 39268
Covered Lines: 37993
Line Coverage: 96.75%
Relevant Branches: 6465
Covered Branches: 6021
Branch Coverage: 93.13%
Branches in Coverage %: Yes
Coverage Strength: 460.61 hits per line

💛 - Coveralls

Comment thread CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md Outdated
Comment thread CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md Outdated

@nikkimk nikkimk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this on. I have just a few change listed.

Comment thread CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md Outdated
Comment thread CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md Outdated
Comment thread CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md Outdated
Comment thread CONTRIBUTOR-DOCS/03_project-planning/05_strategies/forms-strategy-rfc.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. gen2 These issues or PRs map to our 2nd generation work to modernizing infrastructure. skip_vrt Skip VRT build; mark UI Tests green without running Chromatic

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants