You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
4
4
5
5
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
+
8
9
- Press the `Space` key to select `changed packages`, then press `Enter` to move to the next question.
9
10
10
-
`🦋 Which packages should have a major bump?`
11
+
`🦋 Which packages should have a major bump?`
12
+
11
13
- 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.
12
14
13
-
`🦋 Which packages should have a minor bump?`
15
+
`🦋 Which packages should have a minor bump?`
16
+
14
17
- 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.
15
18
16
19
```
@@ -21,5 +24,6 @@ To add an entry to the change log for your pull request, from your feature branc
21
24
🦋 (submit empty line to open external editor)
22
25
🦋 Summary › {CHANGELOG ENTRY}
23
26
```
27
+
24
28
- Follow our [change log content guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#writing-a-changelog-message) to write your entry
Copy file name to clipboardExpand all lines: documentation/Releasing.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,9 @@ To perform a release:
11
11
12
12
- Comment `/snapit` in the **"Version Packages"** PR to cut a snapshot release
13
13
- 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.
15
15
- 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
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.
56
56
57
57
```jsx
58
-
import {AppProvider} from"@shopify/polaris";
58
+
import {AppProvider} from'@shopify/polaris';
59
59
// en.json is English. Replace with fr.json for French, etc
@@ -88,7 +88,7 @@ By default Polaris renders `<Link>` elements (and action objects) as `<a>` tags.
88
88
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.
Copy file name to clipboardExpand all lines: polaris.shopify.com/content/contributing/working-with-the-polaris-team/index.md
+11-10Lines changed: 11 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -13,20 +13,22 @@ Through supporting teams, we’ve learned what works well, and not so well. We
13
13
14
14
## TL;dr
15
15
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.
17
17
18
18
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
21
22
22
23
As you’re building you may need custom styles. In those cases, always use Polaris [tokens](/tokens).
23
24
24
25
## Product team tips
26
+
25
27
With some early planning and intentional systems thinking, the build stage will go a lot smoother.
26
28
27
29
### Plan for systems changes ahead of time
28
30
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.
30
32
31
33
### Aim to systematize your custom solutions
32
34
@@ -88,14 +90,13 @@ These response time goals are for GitHub and our internal #polaris Slack channel
88
90
|**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 |
89
91
|**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 |
90
92
91
-
92
93
### Third party developer response times
93
94
94
95
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:
95
96
96
-
| Contribution type | Team response | How you can help |
| 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