MARS app design guidelines

MARS apps should be of high quality so a smooth installation and problem-free use of the MARS app is guaranteed.

Name *

All MARS apps must contain a Name. The MARS app Name is a unique identifier for the MARS app. It is used in for example URLs and directories.

A MARS app Name:
  • Must be unique.
  • Must only contain small caps.
  • Must only contain alphanumeric characters.

Example

cerm

Descriptive Name *

All MARS apps must contain a Descriptive Name. The MARS app Descriptive Name is the name that is used in MARS by users to refer to the MARS app. The Descriptive Name should contain a clear description of the MARS app.

Example

Cerm Integration Kit

Version number *

All MARS apps must contain a version number. The Version number follows the convention of Semantic Versioning, described on https://semver.org/.

These are the guidelines for incrementing the Major, Minor or Patch version number:
  • Increment the Major version when you make incompatible API changes.
  • Increment the Minor version when you add functionality in a backwards-compatible manner.
  • Increment the Patch version when you make backwards-compatible bug fixes.

Example

  • 1.0.0 for the first version of a MARS app.
  • 1.1.0 when you have added some new functionality.
  • 1.2.0 when you have added some other new functionality.
  • 1.2.1 when you have fixed a bug in the MARS app.
  • 2.0.0 when you created a new major version of the MARS app and the code of the MARS app becomes backwards incompatible

Files *

Files must be added to a subfolder in the root of PP_FILE_STORE with an identical name as the MARS app.

Example

PP_FILE_STORE/cerm/...

HTML pages*

If the MARS app is a Template Application, HTML pages must be built with PAGEBUILDER.

Workflows *

The names of the workflows must start with the MARS app Name.

Example

cerm-xxx

Documentation *

All MARS apps must contain documentation. The documentation file is a Markdown that must be added to a subfolder in the root of PP_FILE_STORE with an identical name as the MARS app.

The documentation must be clear and extended so the use and purpose of the MARS app is evident for all Users.

For Public MARS apps, the provided documentation is used to test the MARS app.

General

Create your MARS app preferably in such a way that it does not need any modification. If this is not possible, make sure that the MARS app needs as less modification as possible.

KISS (Keep It Simple, Stupid)

* These guidelines are enforced for Public MARS apps. This means that all MARS apps that are requested to be published will only be published in case they comply with all these guidelines.

For all other MARS apps, these guidelines are strongly recommended.