Skip to content
Merged
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
5 changes: 5 additions & 0 deletions .changeset/lemon-maps-camp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'polaris.shopify.com': patch
---

copy edits to contribution guidance
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ keywords:

## Our pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, ability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our standards

Expand Down
12 changes: 6 additions & 6 deletions polaris.shopify.com/content/contributing/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,17 @@ If you're just getting started with contributing to Polaris React, look for issu
2. [Prepare your development environment](/contributing/shipping-your-contribution#setting-up-your-local-developement-environment).
3. Assess the time and difficulty of finding and fixing the problem code.
4. If you discover that fixing the bug is too complex or will take longer than you’re able to commit, that’s okay! Your findings will help the next developer move the needle on shipping a fix.
<br /> - Update the issue with a comment detailing your findings. Describe the problem code and share permalinks to the lines involved
<br /> - Update the issue with a comment detailing your findings. Describe the problem code and share permalinks to the lines involved.
<br /> - If you have a potential fix locally, commit and push your changes and open a draft pull request that links to the bug report.
<br /> - Add or update the issue’s labels to indicate level of difficulty
<br /> - Unassign yourself from the issue
<br /> - Add or update the issue’s labels to indicate level of difficulty.
<br /> - Unassign yourself from the issue.
5. If after investigating you arrive at a solution to the issue:
<br /> - Update the issue so everyone knows a fix is on the way
<br /> - Commit your changes and [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr)
<br /> - Update the issue so everyone knows a fix is on the way.
<br /> - Commit your changes and [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr).

---

## Add a new pattern
## Improve components

### Considerations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ keywords:

![Illustration of dozens of chairs of the same kind and a single chair of a diverent kind.](/images/contributing/designing-with-a-system/01.png)

At Shopify, we often say, "Polaris is the floor, not the ceiling." The design system provides you with building blocks, and it's up to you to construct them in a way that best meets your user's needs. The idea behind Polaris not being a ceiling is that you shouldn't limit your ideas to fit into existing system pieces too early. Zoom out, figure out the best design solution to the problem, and then see if Polaris has all the pieces for you to design that solution. If there's a gap, then [contribute](link to top of contribution page) to the system to make it better.
At Shopify, we often say, "Polaris is the floor, not the ceiling." The design system provides you with building blocks, and it's up to you to construct them in a way that best meets your user's needs. The idea behind Polaris not being a ceiling is that you shouldn't limit your ideas to fit into existing system pieces too early. Zoom out, figure out the best design solution to the problem, and then see if Polaris has all the pieces for you to design that solution. If there's a gap, then [contribute](https://polaris.shopify.com/contributing) to the system to make it better.

## Zoom out

Expand Down
4 changes: 2 additions & 2 deletions polaris.shopify.com/content/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ It's important that inaccurate or outdated information be removed as soon as pos

To remove documentation:

1. Reach out to subject matter experts, or someone with high context around the existing content, to confirm its relevance and accuracy.
2. [Open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the [Shopify/polaris repo](https://github.com/Shopify/polaris) GitHub repo.
1. Reach out to subject matter experts, or someone with high context around the existing content, to confirm its relevance and accuracy
2. [Open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the [Shopify/polaris repo](https://github.com/Shopify/polaris) GitHub repo
8 changes: 4 additions & 4 deletions polaris.shopify.com/content/contributing/figma-ui-kit.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Any designer that works at Shopify can contribute to the Figma UI Kit. If you fi
Components, features, or patterns shouldn't be added to the Figma UI Kit if they are not part of Polaris React, as our goal is to keep Figma in sync with the code base. Only contributing changes to the Figma UI Kit when there's a counterpart in Polaris React prevents confusion and keeps tooling in sync across resources.

1. Submit an issue in the [Shopify/polaris](https://github.com/Shopify/polaris/issues/new) GitHub repo, or assign yourself to [an existing issue](https://github.com/Shopify/polaris/labels/Figma%20UI%20Kit). Make sure to:
1. Assign yourself to the issue so it’s clear who is doing the work
2. Add the "Figma UI Kit" label so we can easily find the issue
3. Use a descriptive title
4. Describe the change you're making in the issue itself
1. Assign yourself to the issue so it’s clear who is doing the work.
2. Add the "Figma UI Kit" label so we can easily find the issue.
3. Use a descriptive title.
4. Describe the change you're making in the issue itself.
2. Create a branch in the Polaris Components Figma library.
<br /> - Give your branch a descriptive name, ideally using the GitHub issue number so it's easy to track.
<br /> - For example, "[4963] Navigation design changes"
Expand Down
18 changes: 9 additions & 9 deletions polaris.shopify.com/content/contributing/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ To learn about best practices for designing and using Polaris icons, read the [i
3. If you are designing a new icon:
<br /> - Draft the new icon following the design language guidance in the Polaris Icon Library in Figma.
<br /> - Request feedback from a Polaris designer.
4. If you need assistance designing the new icon
4. If you need assistance designing the new icon:
<br /> - Reach out in the #polaris Slack channel requesting a new icon.
<br /> - A designer will reach out to get context and information around what you need, deadlines and other relevant information.
<br /> - A designer will work with you to design an icon that meets your team’s needs with your feedback along the way.
5. Once alignment on the design is reached, follow the instructions below for adding the icon.

## Add or edit an icon

1. Submit an [icon proposal](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md).
2. [Set up your development environment](/contributing/shipping-your-contribution#get-set-up).
1. Submit an [icon proposal](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md)
2. [Set up your development environment](/contributing/shipping-your-contribution#get-set-up)
3. If you are adding an icon:
<br /> - Copy and rename the icon template files
<br /> - Add the exported icon SVG to the `.svg` file
Expand All @@ -41,18 +41,18 @@ To learn about best practices for designing and using Polaris icons, read the [i
<br /> - Replace the existing icon SVG in the `.svg` file
<br /> - Update the relevant metadata in the `.yml` file
5. Run `yarn changeset` to add an entry to the change log and release notes
6. Commit your changes and [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the Shopify/polaris GitHub repo.
7. Update the Polaris Icon Library in Figma.
6. Commit your changes and [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the Shopify/polaris GitHub repo
7. Update the Polaris Icon Library in Figma

## Deprecate an icon

1. Submit an [icon proposal](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md).
2. [Set up your development environment](/contributing/shipping-your-contribution#get-set-up).
3. If you are deprecating an icon without replacement:
<br /> - Add `deprecated: true` to the icon’s `.yml` file
<br /> - Add `deprecated: true` to the icon’s `.yml` file.
4. If you are deprecating an icon with replacement:
<br /> - Rename the icon’s `.svg` and `.yml` files
<br /> - Add `deprecated_aliases` to the `.yml` file
<br /> - Rename the icon’s `.svg` and `.yml` files.
<br /> - Add `deprecated_aliases` to the `.yml` file.
<br /> - List each of the icon’s previous names. For example, if you were to rename `OldMajor` to `NewMajor`, you would add these lines to `NewMajor.yml`:
<br />

Expand All @@ -61,6 +61,6 @@ To learn about best practices for designing and using Polaris icons, read the [i
- OldMajor
```

5. Run `yarn changeset` to add an entry to the change log and release notes
5. Run `yarn changeset` to add an entry to the change log and release notes.
6. Commit your changes and [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the Shopify/polaris GitHub repo.
7. Update the Polaris Icon Library in Figma.
4 changes: 2 additions & 2 deletions polaris.shopify.com/content/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Contribution to Polaris looks different depending on whether you work at Shopify

## When to contribute

Figuring out what and when to contribute is not always simple, but it doesn't have to be! Here are some common scenarios for deciding when to contribute:
Contributions can seem intimidating, but they don't have to be! Here are some common scenarios for deciding when to contribute:
Copy link
Member

Choose a reason for hiding this comment

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

❤️


| Use the System | Extend the system | Build a custom solution | | |
| Use the system | Extend the system | Build a custom solution | | |
| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | --- | --- |
| _When available resources can solve a design problem_ | _When a change or addition can solve a shared problem_ | _When a unique problem requires a unique solution_ | | |
| Read [ Designing with a system ](/contributing/designing-with-a-system) | Read [ When to contribute new patterns ](/contributing/when-to-contribute-new-patterns) | Share ideas in [ #admin-ux ](https://shopify.slack.com/archives/C039ZAKQ5AA)(Shopify employees) | | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ git checkout -b new-branch-name

### 1. Test your changes

As you work commit and test your changes:
As you work, commit and test your changes:

If your changes affect Polaris React components, you'll need to test the examples and documentation of affected components. For more thorough testing edit the sandbox files found in the `/polaris-react/playground` directory.

Expand All @@ -98,7 +98,7 @@ Save the changes you've made to your branch.
git commit -m “descriptive message”
```

Push up your branch up to GitHub
Push up your branch to GitHub

```bash
git push origin new-branch-name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ Go with E if A seems like a snowflake solution. Building a snowflake solution wi

When both are appropriate and there’s not a massive difference in value, consistency trumps perfection.

The key here is to [zoom out](link to thinking in systems section). When we’re designing for scale, we need to think broader and look at our specific problem area as a small part of a larger system. So spend some time figuring out if your solution is unique, or if it has potential to solve other problems. This is why it’s important to have good awareness of the whole experience before you start, and why it’s key to [contribute back to the system](insert link to contribution page) if you land on a solution that would benefit others.
The key here is to zoom out. When we’re [designing for scale](https://polaris.shopify.com/contributing/designing-with-a-system), we need to think broader and look at our specific problem area as a small part of a larger system. So spend some time figuring out if your solution is unique, or if it has potential to solve other problems. This is why it’s important to have good awareness of the whole experience before you start, and why it’s important to contribute back to the system if you land on a solution that would benefit others.

If you have initial questions about contribution, reach out in [#polaris](https://shopify.slack.com/archives/C4Y8N30KD) if you work at Shopify, or the [Shopify Partners Slack](http://shopifypartners.slack.com) if you're an open source contributor. To get help with the strategy for a larger contribution, start a [GitHub discussion](https://github.com/Shopify/polaris/discussions/new) with the system community.
For initial questions about contribution, reach out in [#polaris](https://shopify.slack.com/archives/C4Y8N30KD) if you work at Shopify, or the [Shopify Partners Slack](http://shopifypartners.slack.com) if you're an open source contributor. To get help with the strategy for a larger contribution, start a [GitHub discussion](https://github.com/Shopify/polaris/discussions/new) with the system community.