From 7854271c2e7a444061194e6701dde780fe0cc499 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Cie=C5=9Blak?= Date: Wed, 30 Oct 2024 11:39:50 +0100 Subject: [PATCH] Update CONTRIBUTING.md, Storybook section --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b4c3332fa..c9dee5c50e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -381,6 +381,26 @@ It offers a number of functionalities that improve development: relative import from the file system. As a consequence, the mechanism for overriding import paths for tests and Storybook's pages will not work. +### Page classification + +To keep the components and Storybook pages in the good shape, a simple classification +has been introduced. It allows to assign pages one of the following statuses: + +- Good + - It is fully possible to interact with the whole component's public API. + - No workarounds are needed to use a component in isolation (like e.g. altering singletons). + - Additional controls are not overly complicated (e.g. the model editor is often not an + ideal solution - it is better to use a separate page for the delegate). + - No errors and warnings printed. +- Decent + - Most of the component's functionality is reachable. + - The component does not print errors, some minor warnings are acceptable only. +- Bad + - The component is not working properly (e.g. some elements are missing). + - Most of the component's functionality is unreachable (lack of additional controls + to interact with the component). + - The page prints many errors/warnings. + ## Unit tests The project has unit tests for both C++ and QML code.