Skip to content

Commit 8ebb9fc

Browse files
Large edit of Contribution section (#7082)
Made some sweeping edits to the contribution guidelines. Started with updating the outdated documentation contribution guidelines but caught a bunch more stuff as I clicked through the different sections: - updated apostrophes to curly style - updated the documentation contribution guidelines (removed mention of office hours, etc) - trying to fix this **bug** where the keywords are showing up in the content: <img width="635" alt="Screen Shot 2022-09-01 at 10 07 57 AM" src="https://user-images.githubusercontent.com/18617698/187972749-cb40fc58-5f12-46d6-877f-98511538bc69.png"> - made intro description less bulky looking by moving part of the paragraph down. Make this: <img width="633" alt="Screen Shot 2022-09-01 at 10 11 40 AM" src="https://user-images.githubusercontent.com/18617698/187973063-55f01674-5b33-4101-981b-932842dc0753.png"> Look more like this: <img width="613" alt="Screen Shot 2022-09-01 at 10 11 52 AM" src="https://user-images.githubusercontent.com/18617698/187973094-c3d7010d-f300-4beb-aabd-ce2f43a1d4b4.png">
1 parent 43ea7e5 commit 8ebb9fc

File tree

12 files changed

+50
-43
lines changed

12 files changed

+50
-43
lines changed

.changeset/sixty-schools-taste.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'polaris.shopify.com': minor
3+
---
4+
5+
Large edit of /contributing

polaris.shopify.com/content/contributing/code-of-conduct/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Examples of unacceptable behavior by participants include:
2323
- The use of sexualized language or imagery and unwelcome sexual attention or advances
2424
- Trolling, insulting/derogatory comments, and personal or political attacks
2525
- Public or private harassment
26-
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
- Publishing others private information, such as a physical or electronic address, without explicit permission
2727
- Other conduct which could reasonably be considered inappropriate in a professional setting
2828

2929
## Our responsibilities
@@ -40,7 +40,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
4040

4141
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
4242

43-
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
43+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the projects leadership.
4444

4545
## Attribution
4646

polaris.shopify.com/content/contributing/components/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ keywords:
1515
- open source
1616
---
1717

18-
Bug fixes can be as simple as removing a typo, or as complex as refactoring a component to address a performance or accessibility issue. Enhancements usually add to or update the props of an existing component to extend its functionality or presentation. New patterns can be contributed by simply adding a new example to an existing component's documentation, or by adding new components or utilities. Often component contributions are a mix of these.
18+
Bug fixes can be as simple as removing a typo, or as complex as refactoring a component to address a performance or accessibility issue. Enhancements usually add to or update the props of an existing component to extend its functionality or presentation. New patterns can be contributed by simply adding a new example to an existing components documentation, or by adding new components or utilities. Often component contributions are a mix of these.
1919

20-
Start planning your contribution as early as possible to account for the scope in your timeline. To get help with the strategy for your contribution early on, start a [discussion](https://github.com/Shopify/polaris/discussions/new) with the Polaris community. If you have a smaller question, reach out in #polaris if you work at Shopify, or the [Shopify Partners Slack](http://shopifypartners.slack.com) if you're an open source contributor. Once you've decided on the best way to solve the problem, submit a [feature proposal](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md) or [bug report](https://github.com/Shopify/polaris/issues/new?assignees=&labels=%F0%9F%90%9BBug&template=ISSUE.md) issue. Then contribute the change by shipping a pull request.
20+
Start planning your contribution as early as possible to account for the scope in your timeline. To get help with the strategy for your contribution early on, start a [discussion](https://github.com/Shopify/polaris/discussions/new) with the Polaris community. If you have a smaller question, reach out in #polaris if you work at Shopify, or the [Shopify Partners Slack](http://shopifypartners.slack.com) if youre an open source contributor. Once youve decided on the best way to solve the problem, submit a [feature proposal](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md) or [bug report](https://github.com/Shopify/polaris/issues/new?assignees=&labels=%F0%9F%90%9BBug&template=ISSUE.md) issue. Then contribute the change by shipping a pull request.
2121

22-
Often the changes you make to a component's code impact the [documentation](/contributing/documentation) and [Figma UI Kit](/contributing/figma-ui-kit). If you work at Shopify, component contributions should be a team effort across disciplines. If you're an open source contributor, we'll work with you to update the Figma UI Kit once you [create an issue](https://github.com/Shopify/polaris/issues/new/choose) or [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the `Shopify/polaris` repo.
22+
Often the changes you make to a components code impact the [documentation](/contributing/documentation) and [Figma UI Kit](/contributing/figma-ui-kit). If you work at Shopify, component contributions should be a team effort across disciplines. If youre an open source contributor, well work with you to update the Figma UI Kit once you [create an issue](https://github.com/Shopify/polaris/issues/new/choose) or [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the `Shopify/polaris` repo.
2323

2424
## Update props
2525

@@ -35,7 +35,7 @@ Components should be performant, accessible, and maintainable. When contributing
3535
- Address a pain point in the merchant experience
3636
- Reduce complexity of the source code
3737

38-
If a component isn't flexible enough to meet your project's requirements, or you're unsure whether a component is right for your use case, submit an [issue](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md) or [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) outlining the problem and the approach you're thinking about. We're happy to collaborate to find a solution.
38+
If a component isnt flexible enough to meet your projects requirements, or youre unsure whether a component is right for your use case, submit an [issue](https://github.com/Shopify/polaris/issues/new?assignees=&labels=Feature+request&template=FEATURE_REQUEST.md) or [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) outlining the problem and the approach youre thinking about. Were happy to collaborate to find a solution.
3939

4040
### How to contribute
4141

@@ -57,13 +57,13 @@ To add or update a prop:
5757

5858
### Considerations
5959

60-
Bug fixes are high impact contributions that ensure we deliver a reliable, crafted experience to merchants. Whether you're a seasoned contributor or looking to make your first pull request, there's a bug report open for every level of experience.
60+
Bug fixes are high impact contributions that ensure we deliver a reliable, crafted experience to merchants. Whether youre a seasoned contributor or looking to make your first pull request, theres a bug report open for every level of experience.
6161

62-
If you're just getting started with contributing to Polaris React, look for issues that are:
62+
If youre just getting started with contributing to Polaris React, look for issues that are:
6363

6464
- Labeled as a [good first issue](https://github.com/Shopify/polaris/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+first+issue%22)
6565
- Not yet assigned to someone
66-
- Haven't been updated in two or more weeks
66+
- Havent been updated in two or more weeks
6767

6868
### How to contribute
6969

@@ -95,7 +95,7 @@ When exploring the potential for improving the look, feel, and or experience of
9595

9696
### Case study
9797

98-
In the years since Polaris launched in 2017, we've learned a lot from the Shopify and design system communities. As the system's matured, we've found that many of the components should evolve toward [composition over configuration](https://maecapozzi.com/blog/composition-vs-configuration/). Many props is a signal that a component is solving too many problems or is too opinionated. When that's the case, there's an opportunity to refactor the component or build a new component to better meet merchant needs.
98+
In the years since Polaris launched in 2017, weve learned a lot from the Shopify and design system communities. As the systems matured, weve found that many of the components should evolve toward [composition over configuration](https://maecapozzi.com/blog/composition-vs-configuration/). Many props is a signal that a component is solving too many problems or is too opinionated. When thats the case, theres an opportunity to refactor the component or build a new component to better meet merchant needs.
9999

100100
For example, `Autocomplete` implements [the combobox with list pattern](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/). When the Deliver team looked into fixing bugs in the component, they decided it would benefit from being broken down into two new components. They contributed `Combobox` and `Listbox` and refactored `Autocomplete` to use them. This reduced complexity and made `Autocomplete` easier to maintain.
101101

polaris.shopify.com/content/contributing/designing-with-a-system/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ keywords:
88

99
![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)
1010

11-
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.
11+
At Shopify, we often say, Polaris is the floor, not the ceiling. The design system provides you with building blocks, and its up to you to construct them in a way that best meets your users needs. The idea behind Polaris not being a ceiling is that you shouldnt 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 theres a gap, then [contribute](https://polaris.shopify.com/contributing) to the system to make it better.
1212

1313
## Zoom out
1414

15-
No matter what problem you're solving, zooming out allows you to get a better understanding of the problem, and its sphere of influence. A problem rarely exists in isolation, so understanding context and contributing factors is key before getting into solutions. Practically speaking, this means that you should understand the product as a whole, not just the product area you're working on.
15+
No matter what problem youre solving, zooming out allows you to get a better understanding of the problem, and its sphere of influence. A problem rarely exists in isolation, so understanding context and contributing factors is key before getting into solutions. Practically speaking, this means that you should understand the product as a whole, not just the product area youre working on.
1616

1717
For instance, if you work on Orders, you should have a holistic understanding of the Shopify admin so you can leverage existing patterns and mental models. You can also gain context and empathy for merchants through research.
1818

19-
Merchants don't care about Shopify's internal organization. They use the admin as a whole, so we must design with the whole experience in mind.
19+
Merchants dont care about Shopifys internal organization. They use the admin as a whole, so we must design with the whole experience in mind.
2020

2121
![Illustration of three tag autocomplete inputs implementing the same pattern, but using different components.](/images/contributing/designing-with-a-system/02.png)
2222

2323
The Deliver team identified a need to consolidate 6 different tag components with varying UX that were doing the same job in different sections of the admin. The redundancy in components was causing a fractured user experience.
2424

2525
## Explore freely
2626

27-
When you understand the product as a whole, you should be well equipped to explore without constraints. That means don't start from our UI kit, component library, or patterns you see in the product---start with a blank sheet of paper instead. Solve the problem, preferably in more than one way, before you start worrying about consistency.
27+
When you understand the product as a whole, you should be well equipped to explore without constraints. That means dont start from our UI kit, component library, or patterns you see in the product---start with a blank sheet of paper instead. Solve the problem, preferably in more than one way, before you start worrying about consistency.
2828

2929
![Illustration of three different ways to improve the design and experience of the tag autocomplete input.](/images/contributing/designing-with-a-system/03.png)
3030

polaris.shopify.com/content/contributing/documentation/index.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Shopify teams create documentation for polaris.shopify.com, but open source cont
1111

1212
To write effectively as a Shopify employee, use a cross-discipline lens. Make sure your content meets both UX and development needs. Before starting, check out our [style guide to the style guide](https://docs.google.com/document/d/1zVDsHIWhoir2svRjdtSdRbD_ruTz3K1nAJcQLGPVQwM/edit#heading=h.ni67tdntu9cr).
1313

14-
Most documentation about the design system is meant for polaris.shopify.com. However, there may be a reason for the content to live elsewhere. If you're not sure if something should live on this site, the Polaris team can help you figure that out.
14+
Most documentation about the design system is meant for polaris.shopify.com. However, there may be a reason for the content to live elsewhere. If youre not sure if something should live on this site, the Polaris team can help you figure that out.
1515

1616
## Making copy edits
1717

1818
Edits related to spelling, grammar, punctuation, or other typos should happen quickly and often. Both Shopify employees and open source contributors are welcome to submit copy edits.
1919

2020
To fix any copy issues on polaris.shopify.com, [open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the [Shopify/polaris repo](https://github.com/Shopify/polaris) GitHub repo.
2121

22-
Note: If you find copy issues in other Polaris resources, follow the steps for that resource's contribution guidelines.
22+
Note: If you find copy issues in other Polaris resources, follow the steps for that resources contribution guidelines.
2323

2424
## Updating documentation
2525

@@ -36,16 +36,18 @@ New documentation in Polaris can range from component documentation, to content
3636

3737
To create new documentation:
3838

39-
1. Book office hours with Polaris to share your rationale for why you think this addition would improve the design system.
40-
2. Once the Polaris team provides feedback, draft the content in Google docs for easy collaboration. We recommend writing in [Markdown](https://www.markdownguide.org/cheat-sheet/), or converting your file to Markdown when finished.
39+
1. Reach out to the Polaris team and we can help you:
40+
- strategize where to add the documentation
41+
- offer strategies and templates for drafting your documentation
42+
- provide asynchronous feedback
43+
- offer ad hoc pair writing session when you get stuck
44+
2. Draft the content in Google docs for easy collaboration. We recommend writing in [Markdown](https://www.markdownguide.org/cheat-sheet/), or converting your file to Markdown when finished.
4145
3. Get feedback from subject matter experts, or someone with high context around your changes (team member, manager, etc.).
42-
4. Reach out to the Polaris team again to review your changes for style guide alignment.
43-
<br /> If on review of the initial proposal the Polaris team suggests that the content should live somewhere besides the Polaris site, you don't need to have the content reviewed for style guide alignment.
44-
5. [Open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the [Shopify/polaris repo](https://github.com/Shopify/polaris) GitHub repo.
46+
4. [Open a pull request](/contributing/shipping-your-contribution#open-your-first-pr) in the [Shopify/polaris repo](https://github.com/Shopify/polaris) GitHub repo.
4547

4648
## Removing documentation
4749

48-
It's important that inaccurate or outdated information be removed as soon as possible. This helps maintain high trust in Polaris as a source of truth for design system guidance.
50+
Its important that inaccurate or outdated information be removed as soon as possible. This helps maintain high trust in Polaris as a source of truth for design system guidance.
4951

5052
To remove documentation:
5153

polaris.shopify.com/content/contributing/figma-ui-kit/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ keywords:
99

1010
Any designer that works at Shopify can contribute to the Figma UI Kit. If you find a bug to fix or your team is contributing new patterns or variants to Polaris React components, we want you to feel empowered to contribute.
1111

12-
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.
12+
Components, features, or patterns shouldnt 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 theres a counterpart in Polaris React prevents confusion and keeps tooling in sync across resources.
1313

1414
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:
1515
1. Assign yourself to the issue so it’s clear who is doing the work.
1616
2. Add the "Figma UI Kit" label so we can easily find the issue.
1717
3. Use a descriptive title.
18-
4. Describe the change you're making in the issue itself.
18+
4. Describe the change youre making in the issue itself.
1919
2. Create a branch in the Polaris Components Figma library.
20-
<br /> - Give your branch a descriptive name, ideally using the GitHub issue number so it's easy to track.
20+
<br /> - Give your branch a descriptive name, ideally using the GitHub issue number so its easy to track.
2121
<br /> - For example, "[4963] Navigation design changes"
2222
3. Make the necessary changes in the new branch.
2323
4. Document all changes in the “Release Notes” page within the UI kit.
24-
5. Add a design reviewer from the Polaris team to review the changes on your branch. If you aren't sure who to add, share the link to your Figma branch and ask for review in the #polaris Slack channel.
24+
5. Add a design reviewer from the Polaris team to review the changes on your branch. If you arent sure who to add, share the link to your Figma branch and ask for review in the #polaris Slack channel.
2525
6. Once reviewed and approved, the Polaris designer will merge your changes into the main branch and publish the updates.

0 commit comments

Comments
 (0)