From 3e435605362e0cfff4124d05153096968695ae41 Mon Sep 17 00:00:00 2001 From: Jason Stoltzfus Date: Thu, 30 Nov 2023 10:46:50 +0000 Subject: [PATCH 1/8] Added a Governance file --- GOVERNANCE.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 GOVERNANCE.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 00000000000..a5ee2d70521 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,43 @@ +# EUI’s Design System Governance + +EUI is a mature library with over 100 publicly exported components, and generally is not actively adding new components. + +## Process +- If a component exists for your use case: + - Use it! +- If a component exists but would require changes to work for your use case: + - Start a conversation with the EUI team, we may be able to help identify a solution or a workaround. +- If you cannot find an existing component or workaround for your use case: + - Start a conversation with the EUI team, we may be able to help identify a solution or a workaround. + - If it is clear a new component does not exist: + - If you believe the feature would qualify as a new addition to EUI (See What we do and don't accept below), submit a feature request. + - If you believe this would require a one-off, please follow the one-off guidelines below. + +## What we do and don’t accept + +**What we do accept** +- Features that are clearly reusable +- New changes must have a clear case for general reuse for Elastic products. Feature requests should include specific examples, or strong evidence of potential reuse. +- Bug fixes :D + +**What we don’t accept** +- Features specific to a single use case (see One-offs, below) +- Features that carry an excessive long-term maintenance burden, relative to their usage +- Features that are inaccessible + +**Open source** +Elastic is an open-source repository, but not completely open-contribution. While we appreciate and welcome all your ideas and contributions, we cannot always guarantee we’ll accept them. Please see our CONTRIBUTING.md for more. + +## What a design system should and shouldn’t do +A design system component should handle 90% of use cases. The remaining 10% may require customization through props, wrapping, or other actions. + +In general, our philosophy is to make our components as flexible and customizable as possible, up to the point where that flexibility explicitly enables bad or inaccessible UX. + +If you can’t find a component that does what you need, start a discussion with us so we can help determine whether your use case is general enough to bring back to EUI, or specific enough to remain a one-off. + +## One-offs +One-offs are a reality in mature design systems. If existing components do not meet your needs, it is acceptable to create a one-off component. One-offs must meet the following criteria to be considered for inclusion in EUI when its usage grows. +- The component must match the look and feel of EUI components +- The component follows EUI best practices, especially UX and accessibility +- The component has undergone manual accessibility testing +- The component has or is included in automated accessibility tests From 6ab7eac6056311de48b9ea30a6b8f7f206b29300 Mon Sep 17 00:00:00 2001 From: Jason Stoltzfus Date: Thu, 30 Nov 2023 11:18:05 +0000 Subject: [PATCH 2/8] Update GOVERNANCE.md Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index a5ee2d70521..e460ec5f5a9 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -10,7 +10,7 @@ EUI is a mature library with over 100 publicly exported components, and generall - If you cannot find an existing component or workaround for your use case: - Start a conversation with the EUI team, we may be able to help identify a solution or a workaround. - If it is clear a new component does not exist: - - If you believe the feature would qualify as a new addition to EUI (See What we do and don't accept below), submit a feature request. + - If you believe the feature would qualify as a new addition to EUI (See [What we do and don't accept](#what-we-do-and-dont-accept) below), submit a feature request. - If you believe this would require a one-off, please follow the one-off guidelines below. ## What we do and don’t accept From fbcb848435a346bfe3a98fa5d2637ae70d176b0e Mon Sep 17 00:00:00 2001 From: Jason Stoltzfus Date: Thu, 30 Nov 2023 11:18:11 +0000 Subject: [PATCH 3/8] Update GOVERNANCE.md Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index e460ec5f5a9..f2a01da9876 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -11,7 +11,7 @@ EUI is a mature library with over 100 publicly exported components, and generall - Start a conversation with the EUI team, we may be able to help identify a solution or a workaround. - If it is clear a new component does not exist: - If you believe the feature would qualify as a new addition to EUI (See [What we do and don't accept](#what-we-do-and-dont-accept) below), submit a feature request. - - If you believe this would require a one-off, please follow the one-off guidelines below. + - If you believe this would require a one-off, please follow the [one-off guidelines](#one-offs) below. ## What we do and don’t accept From 8d3bac6b7b5480eec92f7808e4c602ce0bafbc45 Mon Sep 17 00:00:00 2001 From: Jason Stoltzfus Date: Thu, 30 Nov 2023 11:18:18 +0000 Subject: [PATCH 4/8] Update GOVERNANCE.md Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index f2a01da9876..8e8268539fb 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -21,7 +21,7 @@ EUI is a mature library with over 100 publicly exported components, and generall - Bug fixes :D **What we don’t accept** -- Features specific to a single use case (see One-offs, below) +- Features specific to a single use case (see [One-offs](#one-offs), below) - Features that carry an excessive long-term maintenance burden, relative to their usage - Features that are inaccessible From 1961e8bab96be56c7aef6e3b44115cc51978c18b Mon Sep 17 00:00:00 2001 From: Jason Stoltzfus Date: Thu, 30 Nov 2023 11:18:23 +0000 Subject: [PATCH 5/8] Update GOVERNANCE.md Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 8e8268539fb..55c743ec30c 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -26,7 +26,7 @@ EUI is a mature library with over 100 publicly exported components, and generall - Features that are inaccessible **Open source** -Elastic is an open-source repository, but not completely open-contribution. While we appreciate and welcome all your ideas and contributions, we cannot always guarantee we’ll accept them. Please see our CONTRIBUTING.md for more. +Elastic is an open-source repository, but not completely open-contribution. While we appreciate and welcome all your ideas and contributions, we cannot always guarantee we’ll accept them. Please see our [CONTRIBUTING.md](./wiki/wiki/contributing-to-eui/README.md) for more. ## What a design system should and shouldn’t do A design system component should handle 90% of use cases. The remaining 10% may require customization through props, wrapping, or other actions. From 46fab1dfd8dda05351efb55792ec598f3bc58af4 Mon Sep 17 00:00:00 2001 From: Jason Stoltzfus Date: Thu, 30 Nov 2023 11:18:38 +0000 Subject: [PATCH 6/8] Update GOVERNANCE.md Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 55c743ec30c..bfb3e233710 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -33,7 +33,7 @@ A design system component should handle 90% of use cases. The remaining 10% may In general, our philosophy is to make our components as flexible and customizable as possible, up to the point where that flexibility explicitly enables bad or inaccessible UX. -If you can’t find a component that does what you need, start a discussion with us so we can help determine whether your use case is general enough to bring back to EUI, or specific enough to remain a one-off. +If you can’t find a component that does what you need, [start a discussion](https://github.com/elastic/eui/discussions) with us so we can help determine whether your use case is general enough to bring back to EUI, or specific enough to remain a one-off. ## One-offs One-offs are a reality in mature design systems. If existing components do not meet your needs, it is acceptable to create a one-off component. One-offs must meet the following criteria to be considered for inclusion in EUI when its usage grows. From 61d49a0ddde097289b0a2d3ef288dad7a41304ce Mon Sep 17 00:00:00 2001 From: Jason Stoltzfus Date: Thu, 30 Nov 2023 11:18:43 +0000 Subject: [PATCH 7/8] Update GOVERNANCE.md Co-authored-by: Cee Chen <549407+cee-chen@users.noreply.github.com> --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index bfb3e233710..da0ee96f346 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -17,7 +17,7 @@ EUI is a mature library with over 100 publicly exported components, and generall **What we do accept** - Features that are clearly reusable -- New changes must have a clear case for general reuse for Elastic products. Feature requests should include specific examples, or strong evidence of potential reuse. + - New changes must have a clear case for general reuse for Elastic products. Feature requests should include specific examples, or strong evidence of potential reuse. - Bug fixes :D **What we don’t accept** From bb3b750fae53344051aa0ce9ded3e68e42cf8a4b Mon Sep 17 00:00:00 2001 From: Cee Chen <549407+cee-chen@users.noreply.github.com> Date: Thu, 30 Nov 2023 03:20:07 -0800 Subject: [PATCH 8/8] adfmlsakdfdsf --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index da0ee96f346..a145de5ff49 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -26,7 +26,7 @@ EUI is a mature library with over 100 publicly exported components, and generall - Features that are inaccessible **Open source** -Elastic is an open-source repository, but not completely open-contribution. While we appreciate and welcome all your ideas and contributions, we cannot always guarantee we’ll accept them. Please see our [CONTRIBUTING.md](./wiki/wiki/contributing-to-eui/README.md) for more. +Elastic is an open-source repository, but not completely open-contribution. While we appreciate and welcome all your ideas and contributions, we cannot always guarantee we’ll accept them. Please see our [CONTRIBUTING.md](./wiki/contributing-to-eui/README.md) for more. ## What a design system should and shouldn’t do A design system component should handle 90% of use cases. The remaining 10% may require customization through props, wrapping, or other actions.