Open
Milestone
expires on Apr 30, 2024
Public software review
Milestone ID: 149
The following criteria should be checked for the software review. If you have changes to the list, either edit here directly or discuss in a dedicated issue!
Software quality criteria
The following part is taken from the software quality plan and edited.
-
Storage of the source code on the KM3NeT central gitlab instance with documentation, -
Automated software test are implemented in the repo for the full software code, for core KM3NeT software with full code coverage and benchmark tests. -
The software is made available containerized in a Docker and singularity container. -
The software project is documented: -
The software is listed in the internal wiki entry pointing to the gitlab hosted documentation. -
Inline code documentation with automatic generation is installed and a reference guide for the API is provided. -
Documentation includes a "Getting started" including installation instructions and a description of the core concepts.
-
-
A change procedure is established including versioning following Semantic Versioning 2.0.0 and changelog following the gitlab workflow. -
depending on the programming language are followed, using the C++ Style Guide, also for ROOT-based software, -
The software is licensed according to the KM3NeT licensing rules. -
Clarify long-term maintenance
Recommendations
-
A full tutorial is added, including Getting started / Guides / Concepts / API. -
Additional examples for applications including benchmark and test data are provided. -
Software is tested and benchmarked.
To request any changes to the repository to get the items checked, please create an issue!