Frontend styleguide #57
Conversation
* main: Release 1.0.0b1 Update volto-authomatic to 3.0.0-alpha.6. Release 1.0.0b0 Changelog Use VLT 7.0.0 final Release 1.0.0a31 Update to VLT 7.0.0b7
|
|
||
| It's a backend and frontend setup that serves as baseline and foundation for all kitconcept GmbH distributions built on top of Plone. | ||
|
|
||
| It includes common features, add-ons, configuration, best practices, and shared components that are used across multiple projects. |
There was a problem hiding this comment.
That is also true of VLT and even Volto core. The thing that makes kitconcept-core the right place to put it is if it's something that we want for all kitconcept projects (both intranet and public website) but that is not the right fit for everyone in the Plone community.
There was a problem hiding this comment.
I don't know if I get your point. I wrote this quickly, as a placeholder, at least to have something. I hope that we all can complete it.
|
|
||
| We use TypeScript for all new frontend code. | ||
| Typings does not have to be perfect and crystal correct, but this alone, should be better than using plain JavaScript. | ||
| This helps to catch errors early and improves code quality. |
There was a problem hiding this comment.
Is creating files with .ts / .tsx extension enough, or do we have to do something more? Do we have to do something to enable type checking in our editor?
| import './MyComponent.css'; // ❌ Avoid this | ||
| ``` | ||
|
|
||
| Instead, use VLT theme integration by adding `src/theme/_main.scss` and `src/theme/_variables.scss` files to your add-on. |
There was a problem hiding this comment.
Link to the docs: https://6.docs.plone.org/volto/theming/theming-a-base-theme.html
There was a problem hiding this comment.
PR please.
I'd like that all the team contribute to this and being a living styleguide.
I covered all that came to my mind, anything that I'm missing?
I guess that we it will be a living styleguide, so we can complete it on the go.
@davisagli @ericof Could you both please take care of creating one for the backend?
@ericof also if you can drop some words on the "what-is-core" about the custom Plone build?