From e465a2e573e3b336d46ca5b39425afebe26c56e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Fern=C3=A1ndez=20de=20Alba?= Date: Sun, 8 Dec 2024 15:04:34 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Steve Piercy --- PLIPs.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/PLIPs.md b/PLIPs.md index d5728297a1..9ffa9935a2 100644 --- a/PLIPs.md +++ b/PLIPs.md @@ -1,4 +1,11 @@ -# Useful Information while developing PLIPs +# Plone Improvement Proposals (PLIPs) + +For details of the PLIP process, read the following. + +- [Plone Improvement Proposals (PLIPs)](https://6.docs.plone.org/contributing/core/plips.html) +- [PLIP review](https://6.docs.plone.org/contributing/core/plip-review.html) + +You can also [browse the current list of open PLIPs for Volto](https://github.com/plone/volto/labels/03%20type%3A%20feature%20(plip)). ## 6321 - Remove Semantic UI from CMSUI @@ -7,18 +14,18 @@ Link to PLIP: [Remove Semantic UI from CMSUI](https://github.com/plone/volto/iss ### Directives This PLIP is targeted to Plone 7. -The main goal is to get rid of SemanticUI powered components in the CMSUI. +The main goal is to get rid of Semantic UI powered components in the CMSUI. It is expected to be a long lived branch, and we probably will want some of the changes already available for the API-first story, let's make some assumptions and rules. -All SemanticUI basic, fundamental components should be replaced by their counterparts in `@plone/components`. -Every time that we find that this components are missing, we should create them in `@plone/components` then used in Volto components. -These components will follow the `@plone/components` best practices, written in TypeScript, have accessibility tests and Storybook story. +All Semantic UI basic, fundamental components should be replaced by their counterparts in `@plone/components`. +Every time that we find missing components, we should create them in `@plone/components` and use them in Volto components. +These components will follow the `@plone/components` best practices, including being written in TypeScript, have accessibility tests, and have a Storybook story. We'd like to have these new components out of this PR and used right away, so let's make all the commits around them as atomic as possible so we can cherry pick them safely and push for them in the main branch. -Every new component used in the CMSUI will be transfered from Volto core to a package: `@plone/cmsui`. -By doing so, we will keep track of every new "clean" component and potentially, being able to extract them when we want, and use them in "real" life right away. +Every new component used in the CMSUI will be transfered from Volto core to the package `@plone/cmsui`. +By doing so, we will keep track of every new "clean" component, and potentially—being able to extract them when we want—we can use them in "real" life right away. It will help also to avoid merging hell. When this PLIP is done, the `src/components/manage` folder should be empty (or almost empty). Code in Volto will remain references and imports to the `@plone/cmsui` package. -Once we start, only meaningful changes in `main` in CMSUI components will be backported, in order to again, avoid merging hell. +Once we start, only meaningful changes in `main` in CMSUI components will be backported, again to avoid merging hell.