Resolve "Onboarding information"
All threads resolved!
All threads resolved!
Compare changes
Simon Sendler authored
+ 66
− 80
@@ -2,7 +2,6 @@
@@ -16,15 +15,14 @@ Our goal is to establish better software quality by following standards the deve
**CESSDA's Software Maturity Levels (SML)**: Several organizations already have put a lot of work into developing metrics for good software. Since we didn't want to reinvent the wheel, we decided to adapt (and modify if need be) a metric which suits our needs. [CESSDA](https://www.cessda.eu/) is one of the ERICs, and although it focuses on Social Sciences it has similar requirements regarding its software.
@@ -34,9 +32,11 @@ of relevant and useful mailing lists new developers ought to consider
@@ -47,6 +47,7 @@ familiarity with basal technologies such as XML.
@@ -58,17 +59,18 @@ familiarity with basal technologies such as XML.
@@ -88,8 +90,8 @@ For the more prominent programming languages we have formatting and general styl
@@ -99,7 +101,6 @@ the department.
- **SPARQL**: For SPARQL there is not really any official style guide and there is no possibility to simply include any code style automatically using a code style file. We just collect some advice how to format and use SPARQL code [here](https://github.com/subugoe/rdd-technical-reference/tree/master/style-guides/rdd-sparql.md).
@@ -117,19 +118,19 @@ To ensure the best documentation of our code we meet on a weekly base for a code
@@ -153,7 +154,6 @@ Call diagrams can be useful to follow code and service calls and should be exist
@@ -163,11 +163,11 @@ Call diagrams can be useful to follow code and service calls and should be exist
@@ -181,19 +181,17 @@ Call diagrams can be useful to follow code and service calls and should be exist
> There is a deployment and configuration manual that can guide an experienced operational user through deployment, management and configuration of the software. Exception and failure messages are explained, but descriptions of solutions are not available. Documentation is consistent with current version of the software.
@@ -202,20 +200,21 @@ This may encompass:
@@ -225,12 +224,11 @@ This may encompass:
@@ -255,7 +253,6 @@ We use the following Git servers at the moment in RDD:
@@ -263,19 +260,14 @@ Which one is suitable for you depends on:
@@ -288,7 +280,6 @@ Examples for writing tests in different programming languages are:
@@ -301,20 +292,19 @@ The reason for using a build tool is to be able to build and/or test a code proj
@@ -326,11 +316,10 @@ The reason for using a build tool is to be able to build and/or test a code proj
> Demonstrable usability: A Continuous Integration server job (or equivalent) is available to deploy the packaged/containerised software. Administrators are notified if deployment fails. Versions of deployed software can be upgraded/rolled back from a Continuous Integration server job (or equivalent). Data and/or index files can be restored from a Continuous Integration server job (or equivalent).
@@ -338,11 +327,11 @@ We want to use CI as soon as possible in new projects. Please set up your GitLab
@@ -357,7 +346,6 @@ The workflows we are using currently in Jenkins and GitLab Runner are:
@@ -370,7 +358,6 @@ There is a [full and documented example](https://gitlab.gwdg.de/SADE/SADE/blob/d
@@ -398,8 +385,6 @@ Telegraf collects statistics with input plugins. A list of plugins is [available
@@ -422,13 +407,11 @@ The main idea is to invite all developers to a MR, at least 2 approvals needed f
@@ -458,11 +441,12 @@ Maybe the `license-maven` plugin will help you.
> There are multiple statements embedded into the software product describing unrestricted rights and any conditions for use, including commercial and non-commercial use, and the recommended citation. The list of developers is embedded in the source code of the product, in the documentation, and in the expression of the software upon execution. The intellectual property rights statements are expressed in legal language, machine-readable code, and in concise statements in language that can be understood by laypersons, such as a pre-written, recognisable license.
@@ -495,14 +479,14 @@ MUST be __SML3__:
„Use is possible by most users: Future extensibility is designed into the system for a moderate range of use cases. The procedures for extending the software are defined, whether by source code modification or through the provision of some type of extension functionality (e.g., callback hooks or scripting capabilities). Where source code modification is part of the extension plan, the software is well-structured, has a moderate to high level of cohesion, and has configuration elements clearly separated from logic and display elements.“
@@ -514,13 +498,13 @@ SHOULD be __SML5__:
„Demonstrable usability: It is evident that all functions and data are encapsulated into objects or accessible through web service interfaces. There is consistent error handling with meaningful messages and advice, and use of generic extensions to program languages for stronger type checking and compilation-time error checking. Services are available externally and code within each module contains few independent logical paths.“
@@ -530,11 +514,11 @@ MUST BE __SML5__:
@@ -542,63 +526,67 @@ MUST BE __SML3__:
„Use is possible by most users: The software and software development process comply with open, recognised or proprietary standards, but there is incomplete verification of compliance. Compliance to recognised standards has be tested but this may not be for all components. There is documented evidence of standards being used, but not of the verification of components.“
@@ -608,16 +596,14 @@ SHOULD BE __SML4__