As an Open Data Hub Manager I want to have a Code Development guideline for the project, to help new developers to contribute to the project.

[sseppi]

The tasks of this issue is:

• [x] Code analysis
• [x] Presentation to the project team of the analysis results that includes
  • Proposals of optimization
  • List of pro/contra of the possible solutions
  • Solution suggestions
• [x] The team decides how to g o on in case of doubts
• [x] The guideline is added in the repo as Guideline.md file
• [x] The repo will be refactored (a deidcated issue has been created - #337 )

[sseppi]

@MatteoBiasi We had a meeting yesterday where we decided to take some default configuration (e.g. read only data for the Edit View) directly from the Open API. Considering that we decided also that, once we will have this feature, the Web Component should be implemented in the way that if the Open API doesn't provide any information the data will be read only per default.

We should consider to add this in the Development Guideline.

[sseppi]

Changes of the Guideline agreed during the sprint meeting of 7th march 2023:

Coding Style

• CSS:
  • the classes Tailwind will be included in the Elements template.The decision has been taken since we do not want a mixed approach in the code and since a change of strategy will lead to a big refactoring of the code already developed;
• Components
  • all components will be copied in the src/components/
  • the component that support the inclusion of the component render will have an extension in the file name and must respect a predefined structure (verify if there is forcing via type or there is the need to add a note)

Platform assumptions

• get configuration information from Open API
  • the configuration of a component that renders data should be taken from Open API whenever available;
  • the edit component should be read only per default till Open API doesn't provide the "readonly: true".

[sseppi]

The issue can be closed, for the refactoring the issue #337 has been created.