Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contributor-docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion contributor-docs/adrs/adr-004-children-as-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ For Example, [legacy ActionMenu](https://primer.style/react/deprecated/ActionMen

<br/>

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
Expand Down
2 changes: 1 addition & 1 deletion contributor-docs/adrs/adr-008-interaction-tests.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion contributor-docs/adrs/adr-011-snapshot-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion contributor-docs/adrs/adr-018-responsive-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion contributor-docs/adrs/adr-020-live-regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading