Documentation: Frontend list of do's and don'ts
In order to improve code quality, we should follow the suggestion made by @timzallmann and create a page in the documentation with a list of do's and dont's that we can link to wherever needed.
We already have some documentation with this approach, but there are some cases we don't:
-
Use a function to instantiate a vue app -
Don't use a singleton for the service or the store -
Don't provide an el
option on tests, use $mount() instead -
Don't rely on has-tooltip
classes for vue components -
Don't use data-original-title
, that is something bootstrap adds and that we should not be changing -
In vue components, when you have tooltips use the tooltip mixin - will be merged in 9.2 -
Don't use a class to start a vue app, follow the documentation and create 3 separate files - bundle, service, store