From a880e03bd8e7db09850f6787f052edbd15d9762e Mon Sep 17 00:00:00 2001 From: jjgali <77791660+jjgali@users.noreply.github.com> Date: Tue, 18 Oct 2022 15:10:57 -0500 Subject: [PATCH 1/5] remove-patterns-vs-compositions --- .../content/patterns/design-patterns.md | 25 ------------------- 1 file changed, 25 deletions(-) diff --git a/polaris.shopify.com/content/patterns/design-patterns.md b/polaris.shopify.com/content/patterns/design-patterns.md index ecc5aa48e4f..321e4f5f6a0 100644 --- a/polaris.shopify.com/content/patterns/design-patterns.md +++ b/polaris.shopify.com/content/patterns/design-patterns.md @@ -40,28 +40,3 @@ Patterns are always informed by and designed together with similar patterns. For ![A solution box within a problem box within a situation box.](/images/foundations/patterns/design-patterns/situation-problem-solution.png) Patterns come with a solution, problem, and situation that belong together. Solutions taken out of this context are no longer a pattern. - -## Patterns vs. compositions - -Patterns are for merchants and compositions are for builders. - -### Pattern purpose - -- Design the best possible merchant experience -- Simplify learning the UI -- Improve recognizability and ease of use -- Improve merchants’ admin proficiency - -### Composition purpose - -- Share as much code as possible -- Speed up the build process -- Improve maintainability and reusability -- Ensure build consistency - -### How to distinguish - -- Patterns solve usability problems that relate to the usage of admin, while compositions solve build problems that relate to the build process -- Patterns ensure consistent product experience, while compositions ensure consistent implementation -- A pattern can be hard coded and still be a pattern, and a composition can be using Polaris primitives and tokens and still not be a pattern -- Patterns are the language we speak with merchants, compositions are the code we share among us From e12966a2c4c9f40431d406f124c95dcb64c0a6ba Mon Sep 17 00:00:00 2001 From: jjgali <77791660+jjgali@users.noreply.github.com> Date: Tue, 18 Oct 2022 15:14:22 -0500 Subject: [PATCH 2/5] Update design-patterns.md --- polaris.shopify.com/content/patterns/design-patterns.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/polaris.shopify.com/content/patterns/design-patterns.md b/polaris.shopify.com/content/patterns/design-patterns.md index 321e4f5f6a0..9318f3fb816 100644 --- a/polaris.shopify.com/content/patterns/design-patterns.md +++ b/polaris.shopify.com/content/patterns/design-patterns.md @@ -37,6 +37,6 @@ Patterns are always used in the same way for the same reasons. Merchants need to Patterns are always informed by and designed together with similar patterns. For example, patterns with similar purpose should complement each other, and patterns with similar functionality should share appearance and behavior. -![A solution box within a problem box within a situation box.](/images/foundations/patterns/design-patterns/situation-problem-solution.png) - Patterns come with a solution, problem, and situation that belong together. Solutions taken out of this context are no longer a pattern. + +![A solution box within a problem box within a situation box.](/images/foundations/patterns/design-patterns/situation-problem-solution.png) From 055b72f974697bb7f35d5536ee0f4ba3dbee7aa9 Mon Sep 17 00:00:00 2001 From: jjgali <77791660+jjgali@users.noreply.github.com> Date: Tue, 18 Oct 2022 15:19:01 -0500 Subject: [PATCH 3/5] rearrange principles --- .../content/patterns/design-patterns.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/polaris.shopify.com/content/patterns/design-patterns.md b/polaris.shopify.com/content/patterns/design-patterns.md index 9318f3fb816..82f645e7b1a 100644 --- a/polaris.shopify.com/content/patterns/design-patterns.md +++ b/polaris.shopify.com/content/patterns/design-patterns.md @@ -23,11 +23,7 @@ Do you have ideas or feedback on how we can make these guidelines more empowerin ## Principles -For patterns to be successful, they need to be contextual, consistent, and unified. - -### Contextual - -A pattern is always paired with the problem it solves and the situation it appears in. A solution applied in a context it wasn’t designed for is not a pattern. +For patterns to be successful, they need to be consistent, unified, and contextual. ### Consistent @@ -37,6 +33,8 @@ Patterns are always used in the same way for the same reasons. Merchants need to Patterns are always informed by and designed together with similar patterns. For example, patterns with similar purpose should complement each other, and patterns with similar functionality should share appearance and behavior. -Patterns come with a solution, problem, and situation that belong together. Solutions taken out of this context are no longer a pattern. +### Contextual + +A pattern is always paired with the problem it solves and the situation it appears in. A solution applied in a context it wasn’t designed for is not a pattern. ![A solution box within a problem box within a situation box.](/images/foundations/patterns/design-patterns/situation-problem-solution.png) From 20524f541136a4e2e4a55a25e669f2ed297579f8 Mon Sep 17 00:00:00 2001 From: jjgali <77791660+jjgali@users.noreply.github.com> Date: Tue, 18 Oct 2022 15:19:32 -0500 Subject: [PATCH 4/5] Update design-patterns.md --- polaris.shopify.com/content/patterns/design-patterns.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/polaris.shopify.com/content/patterns/design-patterns.md b/polaris.shopify.com/content/patterns/design-patterns.md index 82f645e7b1a..c50dd22252c 100644 --- a/polaris.shopify.com/content/patterns/design-patterns.md +++ b/polaris.shopify.com/content/patterns/design-patterns.md @@ -15,7 +15,7 @@ A design pattern is a repeatable solution to a common UX problem in a specific m --- -### Join the conversation! +### Join the conversation Do you have ideas or feedback on how we can make these guidelines more empowering and useful? Please share your thoughts in the [GitHub discussion](https://github.com/Shopify/polaris/discussions/6046). From 4384023742642b6db342e3b7246d194d9f5fca57 Mon Sep 17 00:00:00 2001 From: jjgali <77791660+jjgali@users.noreply.github.com> Date: Tue, 18 Oct 2022 15:29:16 -0500 Subject: [PATCH 5/5] Create pretty-bats-know.md --- .changeset/pretty-bats-know.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/pretty-bats-know.md diff --git a/.changeset/pretty-bats-know.md b/.changeset/pretty-bats-know.md new file mode 100644 index 00000000000..48d85353ac3 --- /dev/null +++ b/.changeset/pretty-bats-know.md @@ -0,0 +1,5 @@ +--- +'polaris.shopify.com': minor +--- + +Remove section on compositions vs patterns.