Skip to content

Commit dcc7cbc

Browse files
authored
Run yarn format across monorepo, remove custom prettier config from polaris.shopify.com (Shopify#6866)
* Run prettier on polaris.shopify.com * Create five-camels-sleep.md * Update five-camels-sleep.md
1 parent 655bd48 commit dcc7cbc

File tree

542 files changed

+5331
-5383
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

542 files changed

+5331
-5383
lines changed

.changeset/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# Changesets
22

3-
Hello and welcome! To manage our change log and releases, we use [Changesets](https://github.com/changesets/changesets) to [version](https://semver.org/) and publish code.
3+
Hello and welcome! To manage our change log and releases, we use [Changesets](https://github.com/changesets/changesets) to [version](https://semver.org/) and publish code.
44

55
To add an entry to the change log for your pull request, from your feature branch run `yarn changeset` in your terminal. Use the arrow, spacebar, and return keys to answer the following Changesets CLI questions:
6-
7-
`🦋 Which packages would you like to include?`
6+
7+
`🦋 Which packages would you like to include?`
8+
89
- Press the `Space` key to select `changed packages`, then press `Enter` to move to the next question.
910

10-
`🦋 Which packages should have a major bump?`
11+
`🦋 Which packages should have a major bump?`
12+
1113
- Press the `Enter` key to select none and move to the next question, _*or*_ navigate packages using the arrow keys and press the `Space` key to select the packages with changes that should target a major version.
1214

13-
`🦋 Which packages should have a minor bump?`
15+
`🦋 Which packages should have a minor bump?`
16+
1417
- Press the `Enter` key to select none so that your changes automatically target a patch bump, _*or*_ select packages using the up and down arrow keys and space if your changes should target a minor version.
1518

1619
```
@@ -21,5 +24,6 @@ To add an entry to the change log for your pull request, from your feature branc
2124
🦋 (submit empty line to open external editor)
2225
🦋 Summary › {CHANGELOG ENTRY}
2326
```
27+
2428
- Follow our [change log content guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#writing-a-changelog-message) to write your entry
2529
- Commit and push up

.changeset/five-camels-sleep.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@shopify/polaris-icons': patch
3+
'polaris.shopify.com': patch
4+
---
5+
6+
Run yarn format across monorepo, remove custom prettier config from polaris.shopify.com

.changeset/unlucky-cycles-travel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
'polaris.shopify.com': patch
33
---
44

5-
/content dir follows [website-url]/**/index.md structure
5+
/content dir follows [website-url]/\*\*/index.md structure

documentation/Releasing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ To perform a release:
1111

1212
- Comment `/snapit` in the **"Version Packages"** PR to cut a snapshot release
1313
- Create a draft pull request in `Shopify/web` for the upgrade using the snapshot
14-
- Tag all contributors to the release on the `Shopify/web` pull request and also create a group message tagging all contributors to nudge them for reviews, as well as to verify the changes within `Shopify/web` work as expected.
14+
- Tag all contributors to the release on the `Shopify/web` pull request and also create a group message tagging all contributors to nudge them for reviews, as well as to verify the changes within `Shopify/web` work as expected.
1515
- Once CI passes, merge the **"Version Packages"** PR
16-
- Once the release is available in npm, update the draft PR to the new version and request review from the folks whose changes are part of the release as listed in the release notes
16+
- Once the release is available in npm, update the draft PR to the new version and request review from the folks whose changes are part of the release as listed in the release notes
1717

1818
## Snapshot Release
1919

polaris-icons/icons/StatusActiveMajor.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: active status
22
set: major
3-
description: Used to represent a resource that is in an Active state.
3+
description: Used to represent a resource that is in an Active state.
44
keywords:
55
- active
66
- tick

polaris.shopify.com/.eslintrc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module.exports = {
22
root: true,
3-
extends: ["next/core-web-vitals"],
3+
extends: ['next/core-web-vitals'],
44
rules: {},
55
};

polaris.shopify.com/content/components/app-provider/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ Translations are provided in the locales folder. When using Polaris, you are abl
4343
If a project has only one locale, then you can pass the JSON content from the locale file into `AppProvider`.
4444

4545
```jsx
46-
import { AppProvider } from "@shopify/polaris";
46+
import {AppProvider} from '@shopify/polaris';
4747
// en.json is English. Replace with fr.json for French, etc
48-
import translations from "@shopify/polaris/locales/en.json";
48+
import translations from '@shopify/polaris/locales/en.json';
4949

5050
function App() {
5151
return <AppProvider i18n={translations}>{/* App content */}</AppProvider>;
@@ -55,14 +55,14 @@ function App() {
5555
If a project supports multiple locales, then load them dynamically using [`@shopify/react-i18n`](https://github.com/Shopify/quilt/tree/master/packages/react-i18n#translation). This ensures that you load only the translations you need.
5656

5757
```jsx
58-
import { AppProvider } from "@shopify/polaris";
58+
import {AppProvider} from '@shopify/polaris';
5959
// en.json is English. Replace with fr.json for French, etc
60-
import translations from "@shopify/polaris/locales/en.json";
61-
import { useI18n } from "@shopify/react-i18n";
60+
import translations from '@shopify/polaris/locales/en.json';
61+
import {useI18n} from '@shopify/react-i18n';
6262

6363
function App() {
6464
const [i18n] = useI18n({
65-
id: "Polaris",
65+
id: 'Polaris',
6666
fallback: translations,
6767
translations(locale) {
6868
return import(
@@ -88,7 +88,7 @@ By default Polaris renders `<Link>` elements (and action objects) as `<a>` tags.
8888
The `linkComponent` prop allows you to customise how links behave within Polaris by allowing you to inject your router's own Link component. The following example demonstrates using react-router's `Link` component.
8989

9090
```jsx
91-
import { BrowserRouter, Link as ReactRouterLink } from "react-router-dom";
91+
import {BrowserRouter, Link as ReactRouterLink} from 'react-router-dom';
9292

9393
function App() {
9494
return (
@@ -102,13 +102,13 @@ function App() {
102102

103103
const IS_EXTERNAL_LINK_REGEX = /^(?:[a-z][a-z\d+.-]*:|\/\/)/;
104104

105-
function Link({ children, url = "", external, ref, ...rest }) {
105+
function Link({children, url = '', external, ref, ...rest}) {
106106
// react-router only supports links to pages it can handle itself. It does not
107107
// support arbirary links, so anything that is not a path-based link should
108108
// use a reglar old `a` tag
109109
if (external || IS_EXTERNAL_LINK_REGEX.test(url)) {
110-
rest.target = "_blank";
111-
rest.rel = "noopener noreferrer";
110+
rest.target = '_blank';
111+
rest.rel = 'noopener noreferrer';
112112
return (
113113
<a href={url} {...rest}>
114114
{children}

polaris.shopify.com/content/contributing/working-with-the-polaris-team/index.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@ Through supporting teams, we’ve learned what works well, and not so well. We
1313

1414
## TL;dr
1515

16-
Think about your system needs in the prototype phase of your project so your team can plan for [quality](/contributing/quality-contributions) systems [contributions](/contributing) ahead of the build phase. The Polaris team is here to help you with planning, but we can’t be pulled in last minute to unblock.
16+
Think about your system needs in the prototype phase of your project so your team can plan for [quality](/contributing/quality-contributions) systems [contributions](/contributing) ahead of the build phase. The Polaris team is here to help you with planning, but we can’t be pulled in last minute to unblock.
1717

1818
The best way to get help is through our support channels:
19-
- [GitHub discussions](https://github.com/Shopify/polaris/discussions/6750) to talk to the community about anything from patterns, to potential contributions
20-
- #polaris in Slack if you work at Shopify and have a general inquiry
19+
20+
- [GitHub discussions](https://github.com/Shopify/polaris/discussions/6750) to talk to the community about anything from patterns, to potential contributions
21+
- #polaris in Slack if you work at Shopify and have a general inquiry
2122

2223
As you’re building you may need custom styles. In those cases, always use Polaris [tokens](/tokens).
2324

2425
## Product team tips
26+
2527
With some early planning and intentional systems thinking, the build stage will go a lot smoother.
2628

2729
### Plan for systems changes ahead of time
2830

29-
The Polaris team should never be pulled in to unblock a team from shipping something quickly—we’re here to support and guide teams when they’re planning their strategic system changes ahead of time. Teams at Shopify should start working on their system needs early in the design and build process and are expected to make [quality system contributions](/contributing#what-makes-a-good-contribution) ahead of their ship dates.
31+
The Polaris team should never be pulled in to unblock a team from shipping something quickly—we’re here to support and guide teams when they’re planning their strategic system changes ahead of time. Teams at Shopify should start working on their system needs early in the design and build process and are expected to make [quality system contributions](/contributing#what-makes-a-good-contribution) ahead of their ship dates.
3032

3133
### Aim to systematize your custom solutions
3234

@@ -88,14 +90,13 @@ These response time goals are for GitHub and our internal #polaris Slack channel
8890
| **System inquiry**<br/> A response would help move things along but the problem can continue to be solved without the response | 24 hours | 48 hours |
8991
| **Collaboration request**<br/> An opportunity has been identified for an individual or team to collaborate with Polaris to evolve the system | 72 hours: [Github discussion](https://github.com/Shopify/polaris/discussions/6750) is started | 1 week: Discussions identified for a larger Polaris team collaboration have an issue added to the [Polaris backlog](https://github.com/orgs/Shopify/projects/2250/views/5) for project triaging |
9092

91-
9293
### Third party developer response times
9394

9495
Polaris is an open source project used by Shopify employees, and Shopify Partners building apps. We value all feedback, feature requests, issues, and pull requests from our open source community. However, we aren’t able to accommodate every request and take longer than we’d like to respond to everyone. We review every request and prioritize them against our product roadmap based on user needs. Below is the process for every open source contribution:
9596

96-
| Contribution type | Team response | How you can help |
97-
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
97+
| Contribution type | Team response | How you can help |
98+
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9899
| Bug report | Prioritized against our backlog and roadmap. If there's a clear or urgent need for a fix we'll add it to our backlog. | Leave comments with additional information on how to reproduce the bug and how it's affecting your use case.<br/><br/> If you're interested in a fix, [upvote](https://github.com/Shopify/polaris/issues/new?assignees=&labels=%F0%9F%90%9BBug&template=ISSUE.md) the bug report to let the team know. |
99-
| Feature request | For now, feature requests will be closed and reviewed against our existing backlog and roadmap. We'll evaluate interest in the request and prioritize it for development if there is enough interest and alignment with our product roadmap. | If you're interested in the feature please upvote the request in [GitHub](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md) to let the team know. |
100-
| Pull request | Will review [PRs](https://github.com/Shopify/polaris/pulls) for system alignment, user need, and contribution quality. | Leave comments for code review.<br/><br/> Upvote the request in [GitHub](https://github.com/Shopify/polaris/discussions/6750) to express interest and let the team know you want this feature. |
101-
| Start a [GitHub discussion](https://github.com/Shopify/polaris/discussions/6750) | Review discussions and close or respond as needed | Participate in a discussion to express interest or share your opinion. |
100+
| Feature request | For now, feature requests will be closed and reviewed against our existing backlog and roadmap. We'll evaluate interest in the request and prioritize it for development if there is enough interest and alignment with our product roadmap. | If you're interested in the feature please upvote the request in [GitHub](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md) to let the team know. |
101+
| Pull request | Will review [PRs](https://github.com/Shopify/polaris/pulls) for system alignment, user need, and contribution quality. | Leave comments for code review.<br/><br/> Upvote the request in [GitHub](https://github.com/Shopify/polaris/discussions/6750) to express interest and let the team know you want this feature. |
102+
| Start a [GitHub discussion](https://github.com/Shopify/polaris/discussions/6750) | Review discussions and close or respond as needed | Participate in a discussion to express interest or share your opinion. |

0 commit comments

Comments
 (0)