Skip to content

Requirements and Review of candidates for MSL

Jump to bottom
Dietmar Winkler edited this page Aug 9, 2019 · 6 revisions

This is a list of requirements that need to be in place before a new sub-library can be evaluated for inclusion into the MSL:

  • Compliance to some (to be specified) style guideline. This could include some simple, but useful guidelines like a specification for class / instance name capitalization, proper use of commenting, etc.
  • At least one simulatable model to test each component. Example models, as per the Modelica Test and Compliance Test Suite, should include experiments annotations.
  • A set of reference results along with documentation on the test environment (Modelica tool / version used, solver selection / settings, etc.)
  • Inclusion of a User's Guide and / or Documentation package
  • CLA has to be signed by all the contributors of the to be included library
  • The future maintenance needs to be clarified which also leads to
  • Assignment of at least two library officers that take on the maintenance

See #1489 for the previous discussion.

Clone this wiki locally