How to contribute

Repository Structure

The project structure reflects the structure of the RISCOSS Platform architecture:

• riscoss-platform-dm contains the code of the Domain Manager (DM)
• riscoss-platform-rdr contains the code for the Risk Data Repository (RDR)
• riscoss-platform-analyser is the engine which calculates risk based on data-points stored in the RDR.
• riscoss-platform-jsmile is a wrapper around the proprietary jSmile project which is used by the riscoss-platform-analyser.

There is other code related repositories to be visited in order to have the complete code for the platform:

• riscoss-analyser contains the Risk Analysis Engine (RAE)
• riscoss-data-collector contains all the Risk Data Collectors that can be plugged into the platform

Documenting

For the documentation, we use the Wiki provided by github for this respository. You can:

• Add some pages
• Add some direct links in the sidebar locate at the right

If you need to include some images in the wiki pages, we need to store them in the folder "images" for this wiki. For clonning the wiki repository, you can execute:

git clone [email protected]:riscoss/riscoss-platform-core.wiki.git

This repository contains a folder named images, where you can add the images you need.

For using these images in the Wiki pages, you need to use a sentence like:

[[wiki/images/logo_riscoss_DSP.png]] for references in the wiki pages or ![](https://github.com/RISCOSS/riscoss-platform-core/wiki/images/logo_riscoss_DSP.png) for references you need the full path (e.g. the readme.md file)