From 81d8dd041ad950d32db98c0ee1ffc23128de566a Mon Sep 17 00:00:00 2001 From: toyeshhm Date: Wed, 14 Oct 2026 09:39:44 -0500 Subject: [PATCH] docs: fix ADR 017 cross-reference and typos in contributor docs ADR 017 said it supersedes ADR 009 and linked to ./adr-009-interaction-tests.md, which does not exist. ADR 009 is behavior-isolation; the ADR it actually supersedes is ADR 008 (adr-008-interaction-tests.md), which already points back at ADR 017. Correct the number and link, and the matching "In ADR 009" reference later in the same document. Also fix: - supercedes/superceded -> supersedes/superseded (ADR 017, ADR 008) - "tha twill" -> "that will" (ADR 018) - "Is is then" -> "It is then" (ADR 011) - doubled "a a" and "an an" (ADR 004, ADR 020) - "everytime" -> "every time" (CONTRIBUTING.md) --- contributor-docs/CONTRIBUTING.md | 2 +- contributor-docs/adrs/adr-004-children-as-api.md | 2 +- contributor-docs/adrs/adr-008-interaction-tests.md | 2 +- contributor-docs/adrs/adr-011-snapshot-tests.md | 2 +- contributor-docs/adrs/adr-017-interaction-tests-revisited.md | 4 ++-- contributor-docs/adrs/adr-018-responsive-values.md | 2 +- contributor-docs/adrs/adr-020-live-regions.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/contributor-docs/CONTRIBUTING.md b/contributor-docs/CONTRIBUTING.md index b394879b839..768183ceda3 100644 --- a/contributor-docs/CONTRIBUTING.md +++ b/contributor-docs/CONTRIBUTING.md @@ -273,7 +273,7 @@ If everything looks great, the reviewer will approve the pull request and feel f ### Previewing your changes -We have a GitHub Action that creates a preview of the docs site and the storybook everytime you commit code to a branch. To view the preview site and the preview storybook, navigate to the PR and find the comment from the `github-actions` bot for storybook and `primer` bot for the docs preview. This will include a link to the preview site and the storybook for your branch. +We have a GitHub Action that creates a preview of the docs site and the storybook every time you commit code to a branch. To view the preview site and the preview storybook, navigate to the PR and find the comment from the `github-actions` bot for storybook and `primer` bot for the docs preview. This will include a link to the preview site and the storybook for your branch. ## Deploying diff --git a/contributor-docs/adrs/adr-004-children-as-api.md b/contributor-docs/adrs/adr-004-children-as-api.md index 7e126f346de..1f6f8441fa2 100644 --- a/contributor-docs/adrs/adr-004-children-as-api.md +++ b/contributor-docs/adrs/adr-004-children-as-api.md @@ -265,7 +265,7 @@ For Example, [legacy ActionMenu](https://primer.style/react/deprecated/ActionMen
-When we see a a prop which resembles “childProps" or `renderChild` on the container/parent, it's a sign that we should surface this detail in the API by creating a composite component: +When we see a prop which resembles “childProps" or `renderChild` on the container/parent, it's a sign that we should surface this detail in the API by creating a composite component: ```jsx // we created an additional layer so that diff --git a/contributor-docs/adrs/adr-008-interaction-tests.md b/contributor-docs/adrs/adr-008-interaction-tests.md index c2b81760f30..7282ff330b1 100644 --- a/contributor-docs/adrs/adr-008-interaction-tests.md +++ b/contributor-docs/adrs/adr-008-interaction-tests.md @@ -1,7 +1,7 @@ # Use Interaction testing in storybook to maintain components > **Warning** -> This ADR is superceded by [`ADR 017`](./adr-017-interaction-tests-revisited.md) +> This ADR is superseded by [`ADR 017`](./adr-017-interaction-tests-revisited.md) ## Status diff --git a/contributor-docs/adrs/adr-011-snapshot-tests.md b/contributor-docs/adrs/adr-011-snapshot-tests.md index 4a41134a123..7c19463af39 100644 --- a/contributor-docs/adrs/adr-011-snapshot-tests.md +++ b/contributor-docs/adrs/adr-011-snapshot-tests.md @@ -11,7 +11,7 @@ [Snapshot testing](https://jestjs.io/docs/snapshot-testing) is a strategy that allows a developer to "snapshot" a given value within a test suite. This value could be a primitive within JavaScript, an Array, an object, or the resulting HTML of rendering a component in React. The snapshot of the value is stored within the repo and is then compared against future test runs. -When a change is detected to a snapshot, the test will fail with a diff between the currently stored snapshot and the new snapshot. Within the space of React components, this may happen when a class name changes or the markup of a component changes. Is is then up to the developer to decide if the change is intentional and whether or not to accept this new snapshot as the baseline for future test runs. +When a change is detected to a snapshot, the test will fail with a diff between the currently stored snapshot and the new snapshot. Within the space of React components, this may happen when a class name changes or the markup of a component changes. It is then up to the developer to decide if the change is intentional and whether or not to accept this new snapshot as the baseline for future test runs. A common practice is to snapshot a React component which will capture the HTML output of rendering a component. For example: diff --git a/contributor-docs/adrs/adr-017-interaction-tests-revisited.md b/contributor-docs/adrs/adr-017-interaction-tests-revisited.md index 39ce66a639d..783f0604ac9 100644 --- a/contributor-docs/adrs/adr-017-interaction-tests-revisited.md +++ b/contributor-docs/adrs/adr-017-interaction-tests-revisited.md @@ -10,13 +10,13 @@ ## Context > **Note** -> This ADR supercedes [`ADR 009`](./adr-009-interaction-tests.md) +> This ADR supersedes [`ADR 008`](./adr-008-interaction-tests.md) We author tests using a combination of Jest and Playwright. Typically, Jest is used for unit and integration tests and Playwright is used for Visual Regression Tests against our Storybook. -In `ADR 009`, we proposed using Storybook's [`play` +In `ADR 008`, we proposed using Storybook's [`play` functions](https://storybook.js.org/docs/react/writing-stories/play-function) as the recommended way to author tests that require tests based on user interactions. In this ADR, we would like to revisit this decision. diff --git a/contributor-docs/adrs/adr-018-responsive-values.md b/contributor-docs/adrs/adr-018-responsive-values.md index b622f21d65b..be18978a068 100644 --- a/contributor-docs/adrs/adr-018-responsive-values.md +++ b/contributor-docs/adrs/adr-018-responsive-values.md @@ -31,7 +31,7 @@ when the component hydrates and the viewport size is different than the fallback size on the server. As a result, we would like to offer a paved path for providing responsive props -in a way tha twill not lead to layout shift during server-side rendering. +in a way that will not lead to layout shift during server-side rendering. ## Decision diff --git a/contributor-docs/adrs/adr-020-live-regions.md b/contributor-docs/adrs/adr-020-live-regions.md index 49968f27e66..0ceba403d1a 100644 --- a/contributor-docs/adrs/adr-020-live-regions.md +++ b/contributor-docs/adrs/adr-020-live-regions.md @@ -28,7 +28,7 @@ In components, we see the following scenarios in Primer React: - Announce a message programmatically, such as the number of results for a query Currently, contributors may reach for roles such as `alert` or `status` to -achieve these scenarios. They may also add `aria-live="assertive"` or `aria-live="polite"` with an an `aria-atomic="true"` to an element explicitly. +achieve these scenarios. They may also add `aria-live="assertive"` or `aria-live="polite"` with an `aria-atomic="true"` to an element explicitly. However, both of these approaches do not announce consistently across screen readers. This could be due to live regions being injected dynamically into the document (this includes loading content into the document via React), dynamically changing the visibility of a live region, or some other technique causing an announcement to not be announced.